查询实例列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListInstance

系统规定参数。取值:ListInstance。

RegionId String cn-shanghai

地区

InstanceName String test

实例名称

InstanceStatus String running

实例状态,包括:PENDING(初始化中)、INIT_ERROR(初始化失败)、STARTING(启动中)、RUNNING(运行中)、STOPPING(停止中)、STOPPED(已停止)、DELETING(停止中)、DELETED(已删除)

PageNo Integer 1

页号

PageSize Integer 30

页大小

返回数据

名称 类型 示例值 描述
Code String success

返回值

Instances Array

实例信息

CreateTime String 1562849679000

创建时间

InstanceId String cri-sgedpenzw80e3m3p

实例规格

InstanceName String test

实例名

InstanceSpecification String Enterprise_Basic

企业版规格

InstanceStatus String RUNNING

实例状态

ModifiedTime String 1562849760000

最近修改时间

RegionId String cn-shanghai

区域ID

IsSuccess Boolean true

是否成功

PageNo Integer 1

页号

PageSize Integer 30

页大小

RequestId String A2A9BA68-B264-4953-9154-CE61B1C03BA6

请求ID

示例

请求示例


http(s)://[Endpoint]/?Action=ListInstance
&RegionId=cn-shanghai
&PageNo=1
&PageSize=30
&<公共请求参数>

正常返回示例

XML 格式

<Instances>
    <InstanceName>test</InstanceName>
    <ModifiedTime>1562849760000</ModifiedTime>
    <InstanceSpecification>Enterprise_Basic</InstanceSpecification>
    <InstanceId>cri-sgedpenzw80e3m3p</InstanceId>
    <InstanceStatus>RUNNING</InstanceStatus>
    <CreateTime>1562849679000</CreateTime>
    <RegionId>cn-shanghai</RegionId>
</Instances>
<IsSuccess>true</IsSuccess>
<PageSize>30</PageSize>
<RequestId>A2A9BA68-B264-4953-9154-CE61B1C03BA6</RequestId>
<PageNo>1</PageNo>
<Code>success</Code>

JSON 格式

{
	"IsSuccess":true,
	"PageSize":30,
	"PageNo":1,
	"RequestId":"A2A9BA68-B264-4953-9154-CE61B1C03BA6",
	"Instances":[
		{
			"InstanceStatus":"RUNNING",
			"RegionId":"cn-shanghai",
			"CreateTime":1562849679000,
			"InstanceId":"cri-sgedpenzw80e3m3p",
			"InstanceSpecification":"Enterprise_Basic",
			"ModifiedTime":1562849760000,
			"InstanceName":"test"
		}
	],
	"Code":"success"
}

错误码

访问错误中心查看更多错误码。