一、1. 接口描述
获取审批管理的申请单
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:DescribeApplications。 |
| Version | 是 | String | 公共参数,本接口取值:2019-08-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ClusterId | 否 | String | 集群ID,用于获取指定集群的单据示例值:10001 |
| Limit | 否 | Integer | 分页,限制当前返回多少条记录,大于等于10示例值:1 |
| Offset | 否 | Integer | 分页,从多少条数据开始返回示例值:12 |
| CensorStatus | 否 | Integer | 申请单状态,用于过滤,0-待审核 1-已经审核并提交任务 2-已驳回示例值:0 |
| TableGroupId | 否 | String | 表格组id,用于过滤示例值:32424 |
| TableName | 否 | String | 表格名,用于过滤示例值:testname |
| Applicant | 否 | String | 申请人uin,用于过滤示例值:2131 |
| ApplyType | 否 | Integer | 申请类型,用于过滤,0加表 1删除表 2清理表 3修改表 4表重建 5存储层扩缩容 6接入层扩缩容 7复制表数据 8key回档示例值:0 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| Applications | Array of Application | 申请单列表示例值:{} |
| TotalCount | Integer | 申请单个数示例值:92 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApplications
<公共请求参数>
{
"TableGroupId": "89879",
"ClusterId": "789789",
"Applicant": "23",
"TableName": "testname",
"Limit": 1,
"Offset": 1,
"CensorStatus": 0,
"ApplyType": 0
}
五、输出示例
{
"Response": {
"Applications": [
{
"Applicant": "100000012683",
"ApplicationId": "4-169",
"ApplicationStatus": 2,
"ApplicationType": 2,
"CanCensor": true,
"CanWithdrawal": false,
"ClusterId": "4",
"ClusterName": "xml_1_ly",
"CreatedTime": "2021-02-25 11:58:37",
"ExecuteStatus": "-1",
"ExecuteUser": "222",
"TableGroupId": "1",
"TableGroupName": "zone_1_1",
"TableInstanceId": "null",
"TableName": "add_table10",
"TaskId": "0",
"UpdateTime": "2021-02-25 11:58:37"
}
],
"RequestId": "fdsfdsfdsfdsf",
"TotalCount": 92
}
}
六、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
七、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
八、SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| AuthFailure.UnauthorizedOperation | 接口操作鉴权错误。 |
| FailedOperation.RegionMismatch | 请求的地域不匹配。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |