ListInstances - 获取实例列表_人工智能平台 PAI(PAI)-阿里云帮助中心

获取PAIRec实例的列表。

调试

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

授权信息

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

请求语法

GET /api/v1/instances HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例 ID 模糊匹配过滤。	pairec-test1
SortBy	string	否	排序依据。	Type
Order	string	否	排序方式。	Desc
PageNumber	integer	否	页大小。	1
PageSize	integer	否	页码。	50
Type	string	否	实例类型。 basic-基础版 highleve-升级版 advance-进阶版 standard-标准版	basic

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	BDB621CB-A81E-5D39-8793-39A365CBCC74
Instances	array<object>	实例列表。
Instances	object
InstanceId	string	实例 ID。	pairec-test1
Type	string	实例类型。 basic-基础版 highleve-升级版 advance-进阶版 standard-标准版	basic
Status	string	实例状态。 Initializing-初始化中 Stopped-停止服务 Running-运行中	Initializing
RegionId	string	区域 ID。 cn-shenzhen-深圳 cn-hangzhou- 杭州 cn-beijing - 北京 cn-shanghai- 上海	cn-shenzhen
GmtCreateTime	string	实例创建时间。	2022-10-13 17:34:52.0
GmtModifiedTime	string	实例更新时间。	2022-11-05 09:02:30.0
ExpiredTime	string	实例过期时间。	2022-12-14 00:00:00.0
CommodityCode	string	实例所属的商品 code。	airec_developers_public_cn
ChargeType	string	实例的付费类型，目前仅支持 Subscription（预付费）。	Subscription
Config	object	实例配置。
Engines	array<object>	服务引擎列表。
Engines	object
ComponentCode	string	组件代码。	feature
Type	string	组件类型。	Hologres
Meta	object	元数据。
Monitors	array<object>	配套功能列表。
Monitors	object
ComponentCode	string	组件代码。	featuresets
Type	string	组件类型。	Platform
Meta	object	元数据。
DataManagements	array<object>	建模环境列表。
DataManagements	object
ComponentCode	string	组件代码。	storage
Type	string	组件类型。	OSS
Meta	object	元数据。
OperatingTool	object	运营工具相关配置。
IsEnable	boolean	实例是不是启用了运营工具，取值： true 开启 false 未开启	true
TotalCount	integer	列表内元素总数。	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
            }
          }
        ]
      },
      "OperatingTool": {
        "IsEnable": true
      }
    }
  ],
  "TotalCount": 7
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-05	OpenAPI 返回结构发生变更	查看变更详情