文档

ListInstances - 获取实例列表

更新时间:

获取实例列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hologram:ListInstancesList
  • Instance
    acs:hologram:*:{#accountId}:instance/*

请求语法

POST /api/v1/instances

请求参数

名称类型必填描述示例值
bodyobject

请求体。

resourceGroupIdstring

资源组 ID。

rg-acfmvscak73zmby
tagobject []

实例标签。

keystring

标签键。

mytag
valuestring

标签值。

value
cmsInstanceTypestring

云监控实例类型。取值:

  • standard
  • follower
  • mc-acceleration
  • warehouse
  • high-memory
说明 这是云监控
standard

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D1303CD4-AA70-5998-8025-F55B22C50840
InstanceListobject []

实例列表。

CommodityCodestring

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

hologram_postpay_public_cn
CreationTimestring

创建时间。

2022-12-16T02:24:05Z
ExpirationTimestring

到期时间。

2023-05-04T16:00:00.000Z
InstanceIdstring

实例 ID。

hgpostcn-cn-aaab9ad2d8fb
InstanceNamestring

实例名称。

test_instance
InstanceStatusstring

实例状态。

枚举值:
  • Creating正在创建
  • Running正常运行
  • Suspended停机
  • Allocating正在处理
Running
InstanceTypestring

实例类型。

枚举值:
  • Follower只读从实例
  • Standard普通型
Standard
Tagsobject []

标签列表。

Keystring

标签键。

tag
Valuestring

标签值。

value
InstanceChargeTypestring

实例付费类型。

枚举值:
  • PostPaid按量付费
  • PrePaid包年包月
PrePaid
LeaderInstanceIdstring

主实例 ID。

hgprecn-cn-2r42sqvxm006
SuspendReasonstring

暂停原因。

Manual
EnableHiveAccessstring

是否启用湖仓加速。

枚举值:
  • true开启
  • false关闭
true
Versionstring

实例版本。

1.3.37
ResourceGroupIdstring

资源组 id。

rg-acfmvscak73zmby
Endpointsobject []

域名列表。

Endpointstring

域名。

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

网络类型。

枚举值:
  • VPCSingleTunnel专有网络
  • Intranet内网
  • VPCAnyTunnel新实例不再支持
  • Internet公网
Internet
Enabledboolean

是否启用 Endpoint。

枚举值:
  • true开启
  • false关闭
true
VSwitchIdstring

虚拟交换机 ID。

vsw-wz9oap28raidjevhuszg4
VpcIdstring

VPC ID。

vpc-uf6mrahzyu7uorlqqpz5f
VpcInstanceIdstring

VPC 实例 ID。

hgpostcn-cn-wwo3665tx004-frontend-st
RegionIdstring

地域 ID。

cn-hangzhou
ZoneIdstring

可用区 ID

cn-hangzhou-h
Successstring

调用接口是否成功。

true
ErrorCodestring

错误码。

null
ErrorMessagestring

错误信息。

null
HttpStatusCodestring

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"
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

错误码

HTTP status code错误码错误信息
403NoPermissionRAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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

变更历史

变更时间变更内容概要操作
2023-07-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-06-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2023-05-16OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
2023-04-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
入参OpenAPI 入参发生变更
    删除入参:RegionId
  • 本页导读 (1)