1. 接口描述
接口请求域名: dbbrain.tencentcloudapi.com 。
自治中心-查询自治事件任务详情。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBAutonomyAction。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ActionId | 是 | Integer | 自治任务ID。 示例值:12 |
InstanceId | 是 | String | 实列ID。 示例值:crs-qtmkik3e |
Product | 是 | String | 服务产品类型,支持值包括: "redis" - 云数据库 Redis。 示例值:redis |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ActionId | Integer | 自治任务ID。 示例值:2 |
EventId | Integer | 自治事件ID。 示例值:2 |
TaskId | Integer | 任务ID。 示例值:1 |
Type | String | 类型:支持RedisAutoScaleUp 示例值:RedisAutoScaleUp |
TriggerTime | String | 自治任务触发时间。 示例值:2025-03-12 00:00:00 |
CreateTime | String | 自治任务创建时间。 示例值:2025-03-12 00:00:00 |
UpdateTime | String | 自治任务更新时间。 示例值:2025-03-12 00:00:00 |
FinishTime | String | 自治任务完成时间。 示例值:2025-03-12 00:00:00 |
ExpireTime | Integer | 剩余时间,单位:秒。 示例值:100 |
Reason | String | 触发原因。 示例值:指标"cpu_limit"大于10s持续超过15分钟 |
Status | String | 自治任务状态:支持 RUNNING,FINISHED,TERMINATED,CANCELLED 示例值:RUNNING |
Info | String | 任务相关的图表等信息。 示例值:[{"DataType":"title","Data":{"Name":"扩容任务【7477146】"}},{"Layout":"vertical","DataType":"table","Data":{"Names":["任务类型"],"Data":[{"预期扩容后规格":"4GiB"}]}},{"DataType":"title","Data":{"Name":"触1发原因"}}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询自治事件任务详情
输入示例
POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBAutonomyAction
<公共请求参数>
{
"ActionId": 11,
"InstanceId": "crs-m5toyq2w",
"Product": "redis"
}
输出示例
{
"Response": {
"ActionId": 1295,
"CreateTime": "2025-05-08 14:33:00",
"EventId": 55,
"ExpireTime": 0,
"FinishTime": "2025-05-08 14:50:55",
"Info": "[{\"DataType\":\"title\",\"Data\":{\"Name\":\"扩容任务【7477146】\"}},{\"Layout\":\"vertical\",\"DataType\":\"table\",\"Data\":{\"Names\":[\"任务类型\"],\"Data\":[{\"预期扩容后规格\":\"4GiB\"}]}},{\"DataType\":\"title\",\"Data\":{\"Name\":\"触1发原因\"}}]",
"Reason": "指标\\\"mem_util\\\"大于50%持续超过10分钟",
"RequestId": "80340cd2-adca-4e6a-81af-1ca998426a61",
"Status": "CANCELLED",
"TaskId": 7477145,
"TriggerTime": "2025-05-08 14:33:00",
"Type": "RedisAutoScaleUp",
"UpdateTime": "2025-05-08 14:33:00"
}
}
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签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.UserHasNoStrategy | CAM鉴权错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |