ListInstances - 获取实例列表

获取实例列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hologram:ListInstances

list

*Instance

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

请求语法

POST /api/v1/instances HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求体。

resourceGroupId

string

资源组 ID。

rg-acfmvscak73zmby

tag

array

实例标签。

object

标签详情。

key

string

标签键。

mytag

value

string

标签值。

value

cmsInstanceType

string

云监控实例类型。取值:

  • standard

  • follower

  • mc-acceleration

  • warehouse

  • high-memory

  • serverless

说明

这是云监控

standard

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

D1303CD4-AA70-5998-8025-F55B22C50840

InstanceList

array<object>

实例列表。

object

实例详情。

CommodityCode

string

商品 code,与费用中心产品明细 code 一致

hologram_postpay_public_cn

CreationTime

string

创建时间。

2022-12-16T02:24:05Z

ExpirationTime

string

到期时间。

2023-05-04T16:00:00.000Z

InstanceId

string

实例 ID。

hgpostcn-cn-aaab9ad2d8fb

InstanceName

string

实例名称。

test_instance

InstanceStatus

string

实例状态。

Running

InstanceType

string

实例类型。

Standard

Tags

array<object>

标签列表。

object

标签详情。

Key

string

标签键。

tag

Value

string

标签值。

value

InstanceChargeType

string

实例付费类型。

PrePaid

LeaderInstanceId

string

主实例 ID。

hgprecn-cn-2r42sqvxm006

SuspendReason

string

暂停原因。

Manual

EnableHiveAccess

string

是否启用湖仓加速。

true

Version

string

实例版本。

1.3.37

ResourceGroupId

string

资源组 id。

rg-acfmvscak73zmby

Endpoints

array<object>

域名列表。

object

域名详情。

Endpoint

string

域名。

hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80

Type

string

网络类型。

Internet

Enabled

boolean

是否启用 Endpoint。

true

VSwitchId

string

虚拟交换机 ID。

vsw-wz9oap28raidjevhuszg4

VpcId

string

VPC ID。

vpc-uf6mrahzyu7uorlqqpz5f

VpcInstanceId

string

VPC 实例 ID。

hgpostcn-cn-wwo3665tx004-frontend-st

RegionId

string

地域 ID。

cn-hangzhou

ZoneId

string

可用区 ID

cn-hangzhou-h

StorageType

string

存储类型:

  • redundant:3AZ

  • local:1AZ

redundant

Success

string

调用接口是否成功。

true

ErrorCode

string

错误码。

null

ErrorMessage

string

错误信息。

null

HttpStatusCode

string

http 状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "D1303CD4-AA70-5998-8025-F55B22C50840",
  "InstanceList": [
    {
      "CommodityCode": "hologram_postpay_public_cn",
      "CreationTime": "2022-12-16T02:24:05Z",
      "ExpirationTime": "2023-05-04T16:00:00.000Z",
      "InstanceId": "hgpostcn-cn-aaab9ad2d8fb",
      "InstanceName": "test_instance",
      "InstanceStatus": "Running",
      "InstanceType": "Standard",
      "Tags": [
        {
          "Key": "tag",
          "Value": "value"
        }
      ],
      "InstanceChargeType": "PrePaid",
      "LeaderInstanceId": "hgprecn-cn-2r42sqvxm006",
      "SuspendReason": "Manual",
      "EnableHiveAccess": "true",
      "Version": "1.3.37",
      "ResourceGroupId": "rg-acfmvscak73zmby",
      "Endpoints": [
        {
          "Endpoint": "hgpostcn-cn-aaab9ad2d8fb-cn-hangzhou-internal.hologres.aliyuncs.com:80",
          "Type": "Internet",
          "Enabled": true,
          "VSwitchId": "vsw-wz9oap28raidjevhuszg4",
          "VpcId": "vpc-uf6mrahzyu7uorlqqpz5f",
          "VpcInstanceId": "hgpostcn-cn-wwo3665tx004-frontend-st"
        }
      ],
      "RegionId": "cn-hangzhou",
      "ZoneId": "cn-hangzhou-h",
      "StorageType": "redundant"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

错误码

HTTP status code

错误码

错误信息

描述

403 NoPermission RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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

变更历史

更多信息,参考变更详情