调用GetInstance API查询实例信息-容器镜像服务-阿里云

查询实例信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cr:GetInstance	get	*Instance `acs:cr:{#regionId}:{#accountId}:instance/{#InstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	cri-xkx6vujuhay0****

返回参数

名称	类型	描述	示例值
	object
ModifiedTime	long	修改时间。	1571926560000
RequestId	string	请求 ID。	6EF34B18-4228-470C-860C-D28597CF010E
CreateTime	long	创建时间。	1571926439000
InstanceName	string	实例名称。	shanghai-instance1
InstanceSpecification	string	实例规格。取值： Enterprise_Basic：基础实例。 Enterprise_Standard：标准版实例。 Enterprise_Advanced：高级版实例。	Enterprise_Basic
Code	string	返回值	success
InstanceStatus	string	实例状态，取值： `PENDING`：初始化中。 `INIT_ERROR`：初始化失败。 `STARTING`：启动中。 `RUNNING`：运行中。 `STOPPING`：停止中。 `STOPPED`：已停止。 `DELETING`：删除中。 `DELETED`：已删除。	RUNNING
InstanceId	string	实例 ID。	cri-xkx6vujuhay0****
IsSuccess	boolean	调用是否成功，取值： `true`：调用成功。 `false`：调用失败。	true
ResourceGroupId	string	资源组 ID。	rg-acfmv36i4isx****
InstanceIssue	string	实例问题。	实例问题，取值： OSS_TOO_MANY_BUCKETS：OSS Bucket 数量超限 OSS_BUCKET_ALREADY_EXISTS：同名 OSS Bucket 已存在 OSS_SERVICE_ROLE_UNAUTHORIZED：OSS 权限未授权 USER_NOT_REGISTERED_BY_REAL_NAME：国际站账号在购买中国站 OSS Bucket 时未进行实名认证
Tags	array<object>	实例的标签集合。
Tag	object	实例标签。
TagKey	string	标签键。	test_key
TagValue	string	标签值。	test_value

示例

正常返回示例

JSON格式

{
  "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,
  "ResourceGroupId": "rg-acfmv36i4isx****",
  "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"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
403	NoPrivilege	Access denied for this user.
500	SystemError	Unknown error.

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

变更历史

变更时间	变更内容概要	操作
2023-06-30	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情