Queries instances in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstance

The operation that you want to perform. Set the value to ListInstance.

RegionId String Yes cn-shanghai

The region ID of the instance.

InstanceName String No test

The name of the instance.

InstanceStatus String No RUNNING

The status of the instance. Valid values:

  • PENDING: The instance is being initialized.
  • INIT_ERROR: The instance fails to be initialized.
  • STARTING: The instance is starting.
  • RUNNING: The instance is running.
  • STOPPING: The instance is being stopped.
  • STOPPED: The instance is stopped.
  • DELETING: The repository is being deleted.
  • DELETED: The instance is deleted.
PageNo Integer No 1

The number of the page to return.

PageSize Integer No 30

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
RequestId String A2A9BA68-B264-4953-9154-CE61B1C03BA6

The ID of the request.

Code String success

The return value.

PageNo Integer 1

The page number of the returned page.

IsSuccess Boolean true

Indicates whether the request is successful.

PageSize Integer 30

The number of entries returned per page.

TotalCount Integer 12121

12121

Instances Array of Instances

The instances that are queried.

ModifiedTime String 1562849760000

The time when the instance was last modified.

InstanceName String test

The name of the instance.

CreateTime String 1562849679000

The time when the instance was created.

InstanceSpecification String Enterprise_Basic

The specification of the Container Registry Enterprise Edition instance.

InstanceStatus String RUNNING

The status of the instance.

InstanceId String cri-sgedpenzw80e****

The ID of the instance.

RegionId String cn-shanghai

The region ID of the instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListInstance
&RegionId=cn-shanghai
&PageNo=1
&PageSize=30
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.