1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
本接口 (DescribeExportMachines) 用于导出区域主机列表。
默认接口请求频率限制:20次/秒。
接口更新时间:2022-05-20 15:00:52。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeExportMachines |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件。 |
| Limit | 否 | 否 | Uint64 | 返回数量,默认为10,最大值为100。 示例值: 10 |
| MachineRegion | 是 | 否 | String | 机器所属地域 示例值: ap-region1 |
| MachineType | 是 | 否 | String | 云主机类型。 示例值: CVM |
| Offset | 否 | 否 | Uint64 | 偏移量,默认为0。 示例值: 0 |
| ProjectIds | 否 | 否 | Array of Uint64 | 机器所属业务ID列表 示例值: [1002,1003] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID,需要到接口“异步导出任务”ExportTasks获取DownloadUrl下载地址 示例值: 12 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter.ParsingError | 参数解析错误。 |
| InvalidParameter.MissingParameter | 参数缺失。 |
| InvalidParameter.InvalidFormat | 参数格式错误。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 导出获取区域主机列表
本接口 (DescribeExportMachines) 用于导出区域主机列表。
输入示例
https://cwp.api3.fincloud.tencent.cn/?Action=DescribeExportMachines
&MachineType=CVM
&MachineRegion=ap-city1
&Filters.0.Name=Keywords
&Filters.0.Values.0=10.0.1.1
&Limit=10
&Offset=0
&<Public request parameters> {}
输出示例
{
"Response": {
"TaskId": "1",
"RequestId": "c30f35cb-2f3e-94f5-59ae-316e0f32e660"
}
}