Query Container Registry instances with ListInstance - Container Registry - Alibaba Cloud - Container Registry

Queries the list of instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cr:ListInstance

list

*Instance

acs:cr:{#regionId}:{#accountId}:instance/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceName `deprecated`	string	No	The instance name.	test
InstanceStatus	string	No	The instance status. Valid values: `PENDING`: Initializing. `INIT_ERROR`: Initialization failed. `STARTING`: Starting. `RUNNING`: Running. `STOPPING`: Stopping. `STOPPED`: Stopped. `DELETING`: Deleting. `DELETED`: Deleted.	RUNNING
PageNo	integer	No	The page number.	1
PageSize	integer	No	The page size.	30
ResourceGroupId	string	No	The resource group ID.	rg-acfmv36i4is****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A2A9BA68-B264-4953-9154-CE61B1C03BA6
Code	string	The return code.	success
PageNo	integer	The page number. Default value: 1.	1
IsSuccess	boolean	Indicates whether the operation is successful.	true
PageSize	integer	The page size. Default value: 30.	30
TotalCount	integer	The total number of returned results.	12121
Instances	array<object>	The instance information.
	array<object>	The instance information.
ModifiedTime	string	The last modification time, in UNIX timestamp format. Unit: milliseconds.	1562849760000
InstanceName	string	The instance name.	test
CreateTime	string	The creation time, in UNIX timestamp format. Unit: milliseconds.	1562849679000
InstanceSpecification	string	The Enterprise Edition specification.	Enterprise_Basic
InstanceStatus	string	The instance status.	RUNNING
InstanceId	string	The instance ID.	cri-sgedpenzw80e****
RegionId	string	The region ID.	cn-shanghai
ResourceGroupId	string	The resource group ID.	rg-aek2h3aexpy****
InstanceIssue	string	The instance issue.	Instance issue. Valid values: OSS_TOO_MANY_BUCKETS: The number of OSS buckets exceeds the limit. OSS_BUCKET_ALREADY_EXISTS: An OSS bucket with the same name already exists. OSS_SERVICE_ROLE_UNAUTHORIZED: OSS permissions are not authorized. USER_NOT_REGISTERED_BY_REAL_NAME: The China site account has not completed real-name verification when purchasing an OSS bucket on the China site
Tags	array<object>	The collection of instance tags.
	object	The instance tag.
TagKey	string	The tag key.	test_key
TagValue	string	The tag value.	test_value

Examples

Success response

JSON format

{
  "RequestId": "A2A9BA68-B264-4953-9154-CE61B1C03BA6",
  "Code": "success",
  "PageNo": 1,
  "IsSuccess": true,
  "PageSize": 30,
  "TotalCount": 12121,
  "Instances": [
    {
      "ModifiedTime": "1562849760000",
      "InstanceName": "test",
      "CreateTime": "1562849679000",
      "InstanceSpecification": "Enterprise_Basic",
      "InstanceStatus": "RUNNING",
      "InstanceId": "cri-sgedpenzw80e****",
      "RegionId": "cn-shanghai",
      "ResourceGroupId": "rg-aek2h3aexpy****",
      "InstanceIssue": "实例问题，取值：\nOSS_TOO_MANY_BUCKETS：OSS Bucket 数量超限\n\nOSS_BUCKET_ALREADY_EXISTS：同名 OSS Bucket 已存在\n\nOSS_SERVICE_ROLE_UNAUTHORIZED：OSS 权限未授权\n\nUSER_NOT_REGISTERED_BY_REAL_NAME：国际站账号在购买中国站 OSS Bucket 时未进行实名认证",
      "Tags": [
        {
          "TagKey": "test_key",
          "TagValue": "test_value"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	SystemError	Unknown error.
403	NoPrivilege	Access denied for this user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.