1. 接口描述
接口请求域名： tcr.tencentcloudapi.com 。
查询从实例同步状态
默认接口请求频率限制：5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeReplicationInstanceSyncStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
| RegistryId | 是 | String | 主实例Id 示例值：tcr-12345 |
| ReplicationRegistryId | 是 | String | 复制实例Id 示例值：tcr-12345-5 |
| ReplicationRegionId | 否 | Integer | 复制实例的地域Id 示例值：5 |
| ShowReplicationLog | 否 | Boolean | 是否显示同步日志 示例值：false |
| Offset | 否 | Integer | 日志页号, 默认0 示例值：1 |
| Limit | 否 | Integer | 最大输出条数，默认5，最大为20 示例值：5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReplicationStatus | String | 同步状态 示例值：StatusUnKnow |
| ReplicationTime | String | 同步完成时间 示例值：0001-01-01T00:00:00Z |
| ReplicationLog | ReplicationLog | 同步日志 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询从实例同步状态
输入示例
https://tcr.tencentcloudapi.com/?Action=DescribeReplicationInstanceSyncStatus
&RegistryId=tcr-12345
&ReplicationRegistryId=tcr-12345-5
&ShowReplicationLog=true
&Offset=1
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"ReplicationStatus": "Succeed",
"ReplicationTime": "2021-09-28T08:00:15Z",
"RequestId": "88b91f6a-2fbe-4d5d-9b2e-a9a4a273758d",
"ReplicationLog": [
{
"ResourceType": "image",
"Source": "test/test:[1]",
"Destination": "test/test:[1]",
"Status": "Succeed",
"StartTime": "2021-09-28T07:47:44.302804Z",
"EndTime": "2021-09-28T07:47:53Z"
}
]
}
}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 | 操作不支持。 |