1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
查看自定义镜像列表
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCustomImages。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 是 | Integer | 偏移量 |
Limit | 是 | Integer | 数量限制 |
OrderField | 否 | String | 排序字段,仅支持CreateTime |
Order | 否 | Integer | 排序方式 0:递增(默认) 1:递减 |
ImageId | 否 | String | 按ImageId查找指定镜像信息,ImageId字段存在时其他字段失效 |
SearchKey | 否 | String | 模糊查询过滤,可以查询镜像ID或镜像名 |
ImageStatus.N | 否 | Array of Integer |
镜像状态过滤列表,有效取值为: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 返回镜像数量 |
CustomImageSet | Array of CustomImage | 镜像信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看自定义镜像列表
输入示例
https://bm.tencentcloudapi.com/?Action=DescribeCustomImages
&Limit=3
&Offset=0
&SearchKey=img
&OrderField=CreateTime
&Order=0
&ImageStatus.0=3
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "52e092d0-fd15-4867-a937-1978c139f26b",
"TotalCount": 13,
"CustomImageSet": [
{
"ImageId": "img-2cmi7d5z",
"ImageName": "no-ping1233",
"ImageStatus": 3,
"OsClass": "Ubuntu",
"OsVersion": "14",
"OsBit": 64,
"ImageSize": 485,
"CreateTime": "2018-07-23 10:50:31",
"DeviceClassCode": "PS100v1",
"OsTypeId": 69,
"ImageDescription": "机器",
"PartitionInfoSet": [
{
"Name": "/dev/sda1",
"Size": 2048
},
{
"Name": "/dev/sda2",
"Size": 2048
},
{
"Name": "/dev/sda3",
"Size": 10240
},
{
"Name": "/dev/sda4",
"Size": 3126910
}
]
},
{
"ImageId": "img-m57nhkdn",
"ImageName": "centos6",
"ImageStatus": 3,
"OsClass": "Centos",
"OsVersion": "6.8",
"OsBit": 64,
"ImageSize": 394,
"CreateTime": "2018-07-27 14:55:39",
"DeviceClassCode": "PS001v1",
"OsTypeId": 77,
"ImageDescription": "",
"PartitionInfoSet": [
{
"Name": "/dev/sda1",
"Size": 2048
},
{
"Name": "/dev/sda2",
"Size": 22528
},
{
"Name": "/dev/sda3",
"Size": 2048
},
{
"Name": "/dev/sda4",
"Size": 830078
}
]
},
{
"ImageId": "img-5tws80gz",
"ImageName": "ssh-port",
"ImageStatus": 3,
"OsClass": "Centos",
"OsVersion": "6.8",
"OsBit": 64,
"ImageSize": 394,
"CreateTime": "2018-07-27 16:02:56",
"DeviceClassCode": "PS001v1",
"OsTypeId": 77,
"ImageDescription": "",
"PartitionInfoSet": [
{
"Name": "/dev/sda1",
"Size": 2048
},
{
"Name": "/dev/sda2",
"Size": 22528
},
{
"Name": "/dev/sda3",
"Size": 2048
},
{
"Name": "/dev/sda4",
"Size": 830078
}
]
}
]
}
}
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 | 操作失败。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |