查询实例信息

DescribeInstance（查询实例信息）

接口描述

本接口适用于查询容器镜像服务实例的基本信息。

请求方式

GET/POST

输入参数

参数	类型	是否必选	描述
InstanceId.N	Array of String	否	实例id，若不填，则默认查询该地域下的所有实例
Marker	Integer	否	分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0
MaxResults	Integer	否	单次调用所返回的最大实例数目，默认20，最大99
ProjectId.N	Array of String	否	实例所属项目ID，若不填，则默认查询默认项目
InstanceName	String	否	实例名称，只支持精准匹配

返回参数

参数	类型	描述
TotalCount	Integer	实例数量
InstanceSet	Array of Instance	实例信息
RequestId	String	请求id
MaxResults	Integer	单次调用返回的最大数
Marker	Integer	分页标识，如果调用未返回全部实例，标记下次调用的返回值的起点，如果已返回全部实例，则其值为0

Instance

参数	类型	描述
InstanceId	String	实例id
InstanceName	String	实例名称
InstanceType	String	实例规格
InstanceStatus	String	实例状态，有效值： Creating：创建中 Running：运行中 Deleting：删除中 Error：异常
InternalEndpoint	String	实例内网访问域名
CreateTime	String	实例创建时间
ExpiredTime	String	实例到期时间 注：当ChargeType参数为HourlyInstantSettlement时，此项返回为空
ChargeType	String	计费方式，有效值： HourlyInstantSettlement：按量付费 Monthly：包年包月
ProjectId	String	实例所属项目ID

调用示例

查询容器镜像服务实例的基本信息

输入示例

http://kcrs.api.ksyun.com?Action=DescribeInstance&Version=2021-11-09

返回示例

{
    "TotalCount": 2,
    "InstanceSet": [
        {
            "InstanceId": "c0c8391f-d9ad-47fd-96bb-xxxxxx",
            "InstanceName": "xxxxxx",
            "InstanceType": "basic",
            "InstanceStatus": "Running",
            "InternalEndpoint": "xxxxxx.ksyunkcr.com",
            "CreateTime": "2022-06-20 16:02:09",
            "ExpiredTime": null,
            "ChargeType": "HourlyInstantSettlement",
            "ProjectId": "0"
        },
        {
            "InstanceId": "fc2e0f75-227e-437e-a8db-xxxxxx",
            "InstanceName": "xxxxxx",
            "InstanceType": "basic",
            "InstanceStatus": "Running",
            "InternalEndpoint": "xxxxxx-vpc.ksyunkcr.com",
            "CreateTime": "2022-06-20 15:56:13",
            "ExpiredTime": null,
            "ChargeType": "HourlyInstantSettlement",
            "ProjectId": "0"
        }
    ],
    "RequestId": "a05b165b-68c4-41f8-9dd5-xxxxxx",
    "MaxResults": 20,
    "Marker": 0
}