文档

ListInstances - 获取实例列表

更新时间:

获取PAIRec实例的列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/instances

请求参数

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

实例 ID 模糊匹配过滤。

pairec-test1
SortBystring

排序依据。

Type
Orderstring

排序方式。

Desc
PageNumberinteger

页大小。

1
PageSizeinteger

页码。

50
Typestring

实例类型。

  • basic-基础版
  • highleve-升级版
  • advance-进阶版
  • standard-标准版
basic

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

BDB621CB-A81E-5D39-8793-39A365CBCC74
Instancesobject []

实例列表。

InstanceIdstring

实例 ID。

pairec-test1
Typestring

实例类型。

  • basic-基础版
  • highleve-升级版
  • advance-进阶版
  • standard-标准版
basic
Statusstring

实例状态。

  • Initializing-初始化中
  • Stopped-停止服务
  • Running-运行中
Initializing
RegionIdstring

区域 ID。

  • cn-shenzhen-深圳
  • cn-hangzhou- 杭州
  • cn-beijing - 北京
  • cn-shanghai- 上海
cn-shenzhen
GmtCreateTimestring

实例创建时间。

2022-10-13 17:34:52.0
GmtModifiedTimestring

实例更新时间。

2022-11-05 09:02:30.0
ExpiredTimestring

实例过期时间。

2022-12-14 00:00:00.0
CommodityCodestring

实例所属的商品 code。

airec_developers_public_cn
ChargeTypestring

实例的付费类型,目前仅支持 Subscription(预付费)。

Subscription
Configobject

实例配置。

Enginesobject []

服务引擎列表。

ComponentCodestring

组件代码。

feature
Typestring

组件类型。

Hologres
Metaobject

元数据。

Monitorsobject []

配套功能列表。

ComponentCodestring

组件代码。

featuresets
Typestring

组件类型。

Platform
Metaobject

元数据。

DataManagementsobject []

建模环境列表。

ComponentCodestring

组件代码。

storage
Typestring

组件类型。

OSS
Metaobject

元数据。

TotalCountinteger

列表内元素总数。

7

示例

正常返回示例

JSON格式

{
  "RequestId": "BDB621CB-A81E-5D39-8793-39A365CBCC74",
  "Instances": [
    {
      "InstanceId": "pairec-test1",
      "Type": "basic",
      "Status": "Initializing",
      "RegionId": "cn-shenzhen",
      "GmtCreateTime": "2022-10-13 17:34:52.0",
      "GmtModifiedTime": "2022-11-05 09:02:30.0",
      "ExpiredTime": "2022-12-14 00:00:00.0",
      "CommodityCode": "airec_developers_public_cn",
      "ChargeType": "Subscription",
      "Config": {
        "Engines": [
          {
            "ComponentCode": "feature",
            "Type": "Hologres",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ],
        "Monitors": [
          {
            "ComponentCode": "featuresets",
            "Type": "Platform",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ],
        "DataManagements": [
          {
            "ComponentCode": "storage",
            "Type": "OSS",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ]
      }
    }
  ],
  "TotalCount": 7
}

错误码

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

  • 本页导读 (1)