接口描述
您可以通过该接口查询镜像信息。
请求头
参数名称 |
类型 |
是否必须 |
描述 |
X-Version |
String |
是 |
版本号,取值:2020-08-01 |
X-Action |
String |
是 |
操作接口名,取值:DescribeImages |
请求参数
参数名称 |
类型 |
是否必须 |
示例值 |
描述 |
NamespaceID |
String |
是 |
default-UID |
命名空间ID |
ImageID |
String |
否 |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
镜像ID,默认不传则列出官方以及自定义镜像信息 |
ImageType |
String |
否 |
official |
两种镜像类型:官方或自定义镜像 |
返回参数
参数名称 |
类型 |
示例值 |
描述 |
RequestID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
请求ID |
Code |
String |
Success |
状态码,有InvalidParameter,Forbidden InternalError,Success四种状态 |
ImagesInfo |
Array |
|
详细的镜像信息 |
ImagesInfo
参数名称 |
类型 |
示例值 |
描述 |
ImageName |
String |
CentOS7-6-x86_64-20200917 |
镜像名称 |
ImageID |
String |
3a87cc31-efe6-487c-b28b-11bec3571e7d |
镜像ID |
ImageType |
String |
official |
两种镜像类型:官方或自定义镜像 |
SystemType |
String |
CentOS |
系统类型:CentOS/Ubuntu/其他 |
SystemVersion |
String |
6.8 |
系统版本 |
CreateTime |
Integer |
1599364800 |
创建镜像时间 |
UpdateTime |
Integer |
1599389800 |
修改镜像时间 |
请求示例
入参示例
curl --location --request GET 'kenc.api.ksyun.com?NamespaceID=demo&ImageType=custom' \
--header 'X-Action: DescribeImages' \
--header 'X-Version: 2020-08-01' \
--header 'X-Amz-Date: 20200826T092325Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTDOTh-1tDQjSosbliA0SRHQ/20200826/beijing-6/kenc/aws4_request, SignedHeaders=host;x-amz-date;x-ksc-account-id, Signature=xxxxxxxxxx'
成功示例
{
"Code": "Success",
"ImagesInfo": [
{
"CreateTime": 1604926848,
"ImageID": "a784468b-777a-4ffe-8e2c-e923b08ca0cc",
"ImageName": "test-image",
"ImageType": "custom",
"SystemType": "centos",
"SystemVersion": "6",
"UpdateTime": 1604926889
}
],
"RequestId": "eff5684c-898a-46d7-8c07-5634522abf39"
}
失败示例
{
"RequestId": "b4a518e6-1aeb-47f8-9f8f-5cd441f0da5f",
"Code": "InvalidParameter",
"Message": "Invalid param ImageID."
}