更新印章状态
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
修改印章状态(停用、启用)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:OperateSeals。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 否 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
Act | 否 | Integer | 操作类型,int,目前支持传入以下类型:
示例值:1 |
SealIds.N | 否 | Array of String | 需要操作的印章ID,数组形式,印章ID可从【web控制台->印章 】获取。 示例值:["yDRTZxxxxxJNR"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 启用印章
将停用的印章修改为启用状态
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OperateSeals
<公共请求参数>
{
"Operator": {
"UserId": "yDCAOUUckpycr4l4UuOiTjVB3yTaFaLI"
},
"Act": 1,
"SealIds": [
"yDClqUUckpaj38v1UmGrVdB8iMEXjdyR"
]
}
输出示例
{
"Response": {
"RequestId": "73fd23a3-7e85-48e5-970a-ca50da5e25af"
}
}
5. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。