All Products
Search
Document Center

Container Registry:GetInstance

Last Updated:Dec 30, 2022

Queries details about an instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
cr:GetInstanceRead
  • CR
    acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

cri-xkx6vujuhay0****

Response parameters

ParameterTypeDescriptionExample
object
ModifiedTimelong

The time when the instance was last modified.

1571926560000
RequestIdstring

The ID of the request.

6EF34B18-4228-470C-860C-D28597CF010E
CreateTimelong

The time when the instance was created.

1571926439000
InstanceNamestring

The name of the instance.

shanghai-instance1
InstanceSpecificationstring

The edition of the instance. Valid values: Basic: the Basic Edition Standard: the Standard Edition Advanced: the Advanced Edition

Enterprise_Basic
Codestring

The return value.

success
InstanceStatusstring

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 instance is being deleted.
  • DELETED: The instance is deleted.
RUNNING
InstanceIdstring

The ID of the instance.

cri-xkx6vujuhay0****
IsSuccessboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ResourceGroupIdstring

The ID of the resource group to which the instance belongs.

rg-acfmv36i4isx****

Example

Normal return example

JSONFormat

{
    "ModifiedTime": 1571926560000,
    "RequestId": "6EF34B18-4228-470C-860C-D28597CF010E",
    "CreateTime": 1571926439000,
    "InstanceName": "shanghai-instance1",
    "InstanceSpecification": "Enterprise_Basic",
    "Code": "success",
    "InstanceStatus": "RUNNING",
    "InstanceId": "cri-xkx6vujuhay0****",
    "IsSuccess": true
}

XMLFormat

<GetInstanceResponse>
    <ModifiedTime>1571926560000</ModifiedTime>
    <RequestId>6EF34B18-4228-470C-860C-D28597CF010E</RequestId>
    <CreateTime>1571926439000</CreateTime>
    <InstanceName>shanghai-instance1</InstanceName>
    <InstanceSpecification>Enterprise_Basic</InstanceSpecification>
    <Code>success</Code>
    <InstanceStatus>RUNNING</InstanceStatus>
    <InstanceId>cri-xkx6vujuhay0****</InstanceId>
    <IsSuccess>true</IsSuccess>
</GetInstanceResponse>

Error codes

Http codeError codeError message
403NoPrivilegeAccess denied for this user.
500SystemErrorUnknown error.

For a list of error codes, visit the API error center.