1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于查询实时上云计划列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListRecordPlans。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of RecordPlanBaseInfo | 返回结果,存在计划时,为Json数组格式,不存在计划时,字段数据为空 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 无实时上云计划
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlans
<公共请求参数>
{}
输出示例
{
"Response": {
"Data": null,
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
示例2 有实时上云计划
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRecordPlans
<公共请求参数>
{}
输出示例
{
"Response": {
"Data": [
{
"ChannelCount": 1,
"PlanId": "88ac5ea6c1**********224671d0f94f",
"PlanName": "name1",
"TemplateId": "9ee325e9984b**********805c19b4e1",
"Describe": "",
"RepairMode": 0,
"StreamType": "main",
"LifeCycle": {
"Transition": 10,
"Expiration": 60
},
"Status": 1
},
{
"ChannelCount": 1,
"PlanId": "bf3a4476c7b4**********e8dcb62351",
"PlanName": "name2",
"TemplateId": "48676e89a8c1**********aa36220fa4",
"Describe": "",
"RepairMode": 0,
"StreamType": "main",
"LifeCycle": {
"Transition": 10,
"Expiration": 60
},
"Status": 0
}
],
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
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 | 操作失败 |