获取实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hologram:ListInstances | List |
|
| 无 |
请求语法
POST /api/v1/instances
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| body | object | 否 | 请求体。 | |
| resourceGroupId | string | 否 | 资源组 ID。 | rg-acfmvscak73zmby |
| tag | object [] | 否 | 实例标签。 | |
| key | string | 否 | 标签键。 | mytag |
| value | string | 否 | 标签值。 | value |
| cmsInstanceType | string | 否 | 云监控实例类型。取值：
说明
这是云监控
| standard |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
|---|---|---|
| 403 | NoPermission | RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-19 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-06-20 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-05-16 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-04-26 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
|