GetInstance - 获取实例详细信息

获取指定PAIRec实例的详细信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/instances/{InstanceId} HTTP/1.1

请求参数

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

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-abcdefg1234

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 id。

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
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

实例配置。

Enginesarray<object>

服务引擎列表。

Enginesobject
ComponentCodestring

组件代码。

feature
Typestring

组件类型。

Hologres
Metaobject

元数据。

Monitorsarray<object>

配套功能列表。

Monitorsobject
ComponentCodestring

组件代码。

featuresets
Typestring

组件类型。

Platform
Metaobject

元数据。

DataManagementsarray<object>

建模环境列表。

DataManagementsobject
ComponentCodestring

组件代码。

storage
Typestring

组件类型。

OSS
Metaobject

元数据。

OperatingToolobject

运营工具相关配置。

IsEnableboolean

实例是不是启用了运营工具,取值:

  • True 开启
  • False 未开启
True

示例

正常返回示例

JSON格式

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "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
  }
}

错误码

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

变更历史

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