1. 接口描述
接口请求域名: tcr.tencentcloudapi.com 。
查询创建从实例任务状态
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeReplicationInstanceCreateTasks。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ReplicationRegistryId | 是 | String | 同步实例Id,见实例返回列表中的同步实例ID 示例值:tcr-dg284imq-5-os5gcu |
ReplicationRegionId | 是 | Integer | 同步实例的地域ID,见实例返回列表中地域ID 示例值:5 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskDetail | Array of TaskDetail | 任务详情 |
Status | String | 整体任务状态 示例值:SUCCESS |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询创建从实例任务状态
输入示例
POST / HTTP/1.1
Host: tcr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReplicationInstanceCreateTasks
<公共请求参数>
{
"ReplicationRegistryId": "tcr-dg284imq-5-os5gcu",
"ReplicationRegionId": 5
}
输出示例
{
"Response": {
"RequestId": "72c8900b-f23e-42b3-9281-828a42d590a4",
"Status": "SUCCESS",
"TaskDetail": [
{
"CreatedTime": "2025-01-02T15:10:06+08:00",
"FinishedTime": "2025-01-02T15:10:12+08:00",
"TaskMessage": "",
"TaskName": "SyncDBTask",
"TaskStatus": "SUCCESS",
"TaskUUID": "tcr-task-tcr-dg284imq-5-os5gcu-a152a2ca-2aee-4356-8bd9-09eea73c5c0a"
},
{
"CreatedTime": "2025-01-02T15:10:06+08:00",
"FinishedTime": "2025-01-02T15:10:12+08:00",
"TaskMessage": "",
"TaskName": "CreateTcrCrdTask",
"TaskStatus": "SUCCESS",
"TaskUUID": "tcr-task-tcr-dg284imq-5-os5gcu-d2c2b630-9417-44ea-b056-992de3289f90"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DbError | 数据库错误。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |