1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
用于查询 redis 执行 kill 会话任务后代理节点的执行结果,入参异步任务 ID 从接口 CreateProxySessionKillTask 调用成功后取得。当前 product 只支持:redis。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProxySessionKillTasks。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID。 示例值:crs-test1 |
AsyncRequestIds.N | 是 | Array of Integer | kill 会话异步任务 ID, 接口 CreateProxySessionKillTask 调用成功后获取。 示例值:[1234] |
Product | 是 | String | 服务产品类型,支持值包括: "redis" - 云数据库 Redis。 示例值:redis |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Tasks | Array of TaskInfo | kill 任务的详情。 |
TotalCount | Integer | 任务总数。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 kill 会话任务执行结果
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxySessionKillTasks
<公共请求参数>
{
"InstanceId": "xx",
"Product": "xx",
"AsyncRequestIds": [
0
]
}
输出示例
{
"Response": {
"RequestId": "xx",
"TotalCount": 1,
"Tasks": [
{
"Progress": 100,
"InstProxyList": [
"6511ec503b047be913e30c1bbf1f2c8c861e8347",
"2ce994dadc0e2b27e76ae13d04ab9eadd9665397",
"db0fcd29867e65eb999ce99383d7a06cd21ca077"
],
"AsyncRequestId": 7677678,
"EndTime": "2020-09-22T00:00:00+00:00",
"InstProxyCount": 3,
"InstanceId": "crs-o5chheqz",
"CreateTime": "2020-09-22T00:00:00+00:00",
"StartTime": "2020-09-22T00:00:00+00:00",
"TaskStatus": "finished",
"FinishedProxyList": [
"6511ec503b047be913e30c1bbf1f2c8c861e8347",
"2ce994dadc0e2b27e76ae13d04ab9eadd9665397",
"db0fcd29867e65eb999ce99383d7a06cd21ca077"
],
"FailedProxyList": []
}
]
}
}
5. 开发者资源
腾讯云 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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |