接口请求域名: organization.intl.tencentcloudapi.com 。
查询异步任务列表
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListTasks。 |
| Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneId | 是 | String | 空间 ID。 |
| PrincipalId | 否 | String | 用户同步 ID。取值: 当PrincipalType取值为Group时,该值为用户组 ID(g-), 当PrincipalType取值为User时,该值为用户 ID(u-)。 |
| NextToken | 否 | String | 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。 |
| MaxResults | 否 | Integer | 每页的最大数据条数。 取值范围:1~100。 默认值:10。 |
| PrincipalType | 否 | String | CAM 用户同步的身份类型。取值: User:表示同步的身份是用户。 Group:表示同步的身份是用户组。 |
| TargetUin | 否 | Integer | 同步的集团账号目标账号的UIN。 |
| TargetType | 否 | String | 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 |
| RoleConfigurationId | 否 | String | 权限配置ID。 |
| Status | 否 | String | InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。 |
| TaskType | 否 | String | 任务类型。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NextToken | String | 查询返回结果下一页的令牌。 说明 只有IsTruncated为true时,才显示该参数。 |
| TotalCounts | Integer | 符合请求参数条件的数据总条数。 |
| MaxResults | Integer | 每页的最大数据条数。 |
| IsTruncated | Boolean | 返回结果是否被截断。取值: true:已截断。 false:未截断。 |
| Tasks | Array of TaskInfo | 任务详情 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
查询异步任务列表
POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListTasks
<公共请求参数>
{
"ZoneId": "z-djwidnwidj",
"PrincipalId": "u-xj8sncidnc",
"NextToken": "xownw8db38dbe8fne==-",
"MaxResults": 1,
"PrincipalType": "User",
"TargetUin": 1000023423,
"TargetType": "Member",
"RoleConfigurationId": "rc-xjw9dsmw",
"Status": "InProgress",
"TaskType": "CreateRoleAssignment"
}
{
"Response": {
"NextToken": "sgt*****",
"TotalCounts": 1,
"MaxResults": 10,
"IsTruncated": true,
"Tasks": [
{
"TaskId": "t-xsinsxinsdk",
"RoleConfigurationId": "rc-xmw9xjdsd",
"RoleConfigurationName": "配置",
"TargetUin": 1000232234,
"TargetType": "User",
"PrincipalId": "u-xm89dnsujs",
"PrincipalType": "Member",
"TaskType": "CreateRoleAssignment",
"Status": "InProgress",
"FailureReason": ""
}
],
"RequestId": "e297543a-80de-4039-83c8-9d35d4545"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.IdentityCenterNotOpen | CIC服务没有开通 |
| FailedOperation.ZoneIdNotExist | CIC服务的用户zoneId不存在 |
| InvalidParameter.NextTokenInvalid | 无效的nextToken |
文档反馈