獲取實例列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hologram:ListInstances | list |
|
| 無 |
請求語法
POST /api/v1/instances HTTP/1.1
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 請求體。 | |
resourceGroupId | string | 否 | 資源組 ID。 | rg-acfmvscak73zmby |
tag | array<object> | 否 | 實例標簽。 | |
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 入參發生變更 | 查看變更詳情 |