1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
本接口(DescribeSubscribeCheckJob)用于查询订阅校验任务结果。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSubscribeCheckJob。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SubscribeId | 是 | String | 数据订阅实例的 ID 示例值:subs-l4d3a7izai |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SubscribeId | String | 订阅实例ID 示例值:subs-xxxxxx |
Message | String | 失败或者报错提示,成功则提示success。 注意:此字段可能返回 null,表示取不到有效值。 示例值:success |
Status | String | 任务运行状态,可能值为 running,failed,success 示例值:success |
Progress | Integer | 当前总体进度,范围 0~100 示例值:100 |
StepAll | Integer | 校验总步骤数 示例值:5 |
StepNow | Integer | 当前执行步骤 示例值:5 |
Steps | Array of SubscribeCheckStepInfo | 各个步骤运行状态 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询订阅校验任务结果
查询订阅校验任务结果
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscribeCheckJob
<公共请求参数>
{
"SubscribeId": "subs-l4d3a7izai"
}
输出示例
{
"Response": {
"Message": "success",
"Progress": 100,
"RequestId": "b048a800-f2fe-11ed-a211-5df19a912eab",
"Status": "success",
"StepAll": 5,
"StepNow": 5,
"Steps": [
{
"Errors": [],
"Percent": 100,
"Status": "finished",
"StepId": "ConnectDBCheck",
"StepName": "连接DB检查",
"StepNo": 1,
"Warnings": []
},
{
"Errors": [],
"Percent": 100,
"Status": "finished",
"StepId": "OptimizeCheck",
"StepName": "周边检查",
"StepNo": 2,
"Warnings": []
},
{
"Errors": [],
"Percent": 100,
"Status": "finished",
"StepId": "VersionCheck",
"StepName": "版本检查",
"StepNo": 3,
"Warnings": []
},
{
"Errors": [],
"Percent": 100,
"Status": "finished",
"StepId": "SrcPrivilegeCheck",
"StepName": "源实例权限检查",
"StepNo": 4,
"Warnings": [
{
"HelpDoc": "",
"Message": "我们不需要能修改您源端数据的权限,请取消他们。例如,您的授权情况:GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER, CREATE TABLESPACE, CREATE ROLE, DROP ROLE ON *.* TO `root`@`%` WITH GRANT OPTION,GRANT APPLICATION_PASSWORD_ADMIN,ROLE_ADMIN,SHOW_ROUTINE,XA_RECOVER_ADMIN ON *.* TO `root`@`%` WITH GRANT OPTION 请参考 https://cloud.tencent.com/document/product/571/52412"
}
]
},
{
"Errors": [],
"Percent": 100,
"Status": "finished",
"StepId": "BinlogParamCheck",
"StepName": "binlog参数检查",
"StepNo": 5,
"Warnings": []
}
],
"SubscribeId": "subs-9jyki7hniw"
}
}
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签名/鉴权错误。 |
AuthFailure.AuthFailureError | 认证失败。 |
FailedOperation | 操作失败。 |
FailedOperation.FailedOperationError | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalErrorError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidParameterError | 参数无效。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.OperationDeniedError | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |