1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
查询快照回滚结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSnapshotRollbackResult。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名 示例值:xxyy.com |
TaskId | 是 | Integer | 快照回滚任务 ID 示例值:124 |
DomainId | 否 | Integer | 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。 示例值:3123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Domain | String | 快照所属域名 示例值:xxyy.com |
LeftMinutes | Integer | 回滚剩余时间(分钟) 示例值:341 |
Progress | Integer | 回滚进度百分比 示例值:11 |
SnapshotId | String | 快照 ID 示例值:DFG335E |
Status | String | 回滚状态 示例值:waiting |
TaskId | Integer | 快照回滚任务 ID 示例值:123 |
Success | Integer | 成功数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
Failed | Integer | 失败数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Total | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
FailedRecordList | Array of SnapshotRecord | 失败详细信息 注意:此字段可能返回 null,表示取不到有效值。 |
CosUrl | String | 快照的下载地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://cos.xx.com/xxx.csv |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询快照回滚结果,已完成
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshotRollbackResult
<公共请求参数>
{
"Domain": "domain.com",
"TaskId": 177
}
输出示例
{
"Response": {
"RequestId": "d4c4c0e9-ca5a-44a2-9d51-b0c64656b8bb",
"TaskId": 177,
"SnapshotId": "A45AXXXX",
"Success": 63,
"Failed": 0,
"CosUrl": "https://newdnspod-1252120672.cos.ap-shanghai.myqcloud.com/snapshot_rollback_91724229_xxx.csv",
"Status": "ok",
"Progress": 100,
"LeftMinutes": 0,
"Total": 63,
"Domain": "domain.com",
"FailedRecordList": []
}
}
示例2 查询快照回滚结果,进行中
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSnapshotRollbackResult
<公共请求参数>
{
"Domain": "domain.com",
"TaskId": 177
}
输出示例
{
"Response": {
"RequestId": "a7723f78-ff6f-43bc-89ee-bc225376276b",
"TaskId": 177,
"SnapshotId": "A45AXXXX",
"Status": "waiting",
"Domain": "domain.com",
"Progress": 0,
"LeftMinutes": 1,
"Success": null,
"Failed": null,
"Total": null,
"CosUrl": null,
"FailedRecordList": null
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.UnknowError | 操作未响应,请稍后重试。 |
InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
InvalidParameterValue.DomainNotExists | 当前域名有误,请返回重新操作。 |
OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
OperationDenied.NoPermissionToOperateDomain | 当前域名无权限,请返回域名列表。 |