GetLindormInstanceList - 擷取Lindorm執行個體列表 -

擷取Lindorm執行個體列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

lindorm:GetLindormInstanceList

get

*Instance

acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	執行個體所屬的地區 ID，可調用 DescribeRegions 介面擷取。	cn-hangzhou
QueryStr	string	否	執行個體名稱關鍵字，可根據該關鍵字模糊搜尋。	test
PageNumber	integer	否	指定要查詢的頁碼。	1
PageSize	integer	否	指定分頁查詢時每頁行數。	20
ServiceType	string	否	執行個體類型，取值： lindorm：表示 Lindorm 單可用性區域執行個體。 lindorm_multizone：表示 Lindorm 多可用性區域執行個體。 serverless_lindorm：表示 Lindorm Serverless 執行個體。 lindorm_standalone：表示 Lindorm 單節點執行個體。 lts：表示 Lindorm 資料通道服務類型。	lindorm
SupportEngine	integer	否	查詢的執行個體支援的資料引擎類型，取值： 1：支援搜尋引擎。 2：支援時序引擎。 4：支援寬表引擎。 8：支援檔案引擎。說明例如：SupportEngine 取值為 15，15=8+4+2+1，表示該執行個體支援搜尋引擎、時序引擎、寬表引擎和檔案引擎。SupportEngine 取值為 6，6=4+2，表示該執行個體支援時序引擎和寬表引擎。	15
Tag	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	標籤的鍵。N 的取值範圍：1~20。說明可以傳入多個標籤的鍵。例如：第一對中的 Key 表示傳入第一個標籤的鍵。第二對中的 Key 表示傳入第二個標籤的鍵。	test
Value	string	否	標籤的值。N 的取值範圍：1~20。說明可以傳入多個標籤的值。例如：第一對中的 Value 表示傳入第一個標籤的值。第二對中的 Value 表示傳入第二個標籤的值。	2.2.18
ResourceGroupId	string	否	資源群組 ID。	rg-aek3b63arvg27vi

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0
PageNumber	integer	執行個體所在頁碼。	1
PageSize	integer	執行個體所在頁的行數。	20
Total	integer	查詢到的執行個體總數。	1
InstanceList	array<object>	執行個體列表。
	array<object>
VpcId	string	執行個體所屬的專用網路 ID。	vpc-bp1n3i15v90el48nx****
EngineType	string	執行個體支援引擎的類型，傳回值是由下列引擎類型的值做加法運算後得到的。 1：支援搜尋引擎。 2：支援時序引擎。 4：支援寬表引擎。 8：支援檔案引擎。說明例如：EngineType 值為 15，15=8+4+2+1，表示該執行個體支援搜尋引擎、時序引擎、寬表引擎和檔案引擎。EngineType 值為 6，6=4+2，表示該執行個體支援時序引擎和寬表引擎。	15
ExpireTime	string	執行個體的到期時間。說明執行個體的付費類型為訂用帳戶，才會返回本參數。	2022-04-26 00:00:00
CreateTime	string	執行個體的建立時間。	2021-09-16 14:13:13
PayType	string	執行個體的付費類型，傳回值： PREPAY：訂用帳戶。 POSTPAY：隨用隨付。	PREPAY
AliUid	integer	阿里雲帳號（主帳號）的 16 位 AliUid。	164901546557****
InstanceStorage	string	執行個體的儲存容量。	960
InstanceId	string	執行個體 ID。	ld-bp17pwu1541ia****
NetworkType	string	執行個體的網路類型。	vpc
ServiceType	string	執行個體類型，傳回值： lindorm：表示 Lindorm 執行個體。 serverless_lindorm：表示 LindormServerless 執行個體。 lindorm_standalone：表示 Lindorm 單節點執行個體。 lts：表示 Lindorm 資料通道服務類型。	lindorm
RegionId	string	地區 ID。	cn-hangzhou
CreateMilliseconds	integer	表示執行個體建立時間與 1970-01-01 00:00:00 之間的毫秒值。	1631772842000
InstanceAlias	string	執行個體名稱。	test
ZoneId	string	可用性區域 ID。	cn-hangzhou-h
InstanceStatus	string	執行個體狀態，傳回值： CREATING：建立中。 ACTIVATION：運行中。 COLD_EXPANDING：容量型雲端儲存擴容中。 MINOR_VERSION_TRANSING：小版本升級中。 RESIZING：節點擴容中。 SHRINKING：節點縮容中。 CLASS_CHANGING：升級規格中或者降配規格中。 SSL_SWITCHING：SSL變更中。 CDC_OPENING：資料訂閱功能開通中。 TRANSFER：資料移轉中。 DATABASE_TRANSFER：資料移轉至資料庫中。 GUARD_CREATING：生產災備執行個體中。 BACKUP_RECOVERING：備份恢複中。 DATABASE_IMPORTING：資料匯入中。 NET_MODIFYING：網路變更中。 NET_SWITCHING：內網和外網切換中。 NET_CREATING：建立網路連結中。 NET_DELETING：刪除網路連結中。 DELETING：刪除中。 RESTARTING：重啟中。 LOCKED：執行個體已到期，鎖定中。	ACTIVATION
ExpiredMilliseconds	integer	執行個體到期時間與 1970-01-01 00:00:00 之間的毫秒值。	1650902400000
EnableStream	boolean	執行個體是否開通流引擎，傳回值： true：開通流引擎。 false：未開通流引擎。	true
Tags	array<object>	標籤列表。
	object
Key	string	標籤的鍵。	test
Value	string	標籤的值。	2.2.18
EnableCompute	boolean	是否開通執行個體的計算引擎，返回： true：已開通。 false：未開通。	true
ResourceGroupId	string	資源群組 ID。	rg-aekzledqeat****
EnableMessage	boolean	是否開通訊息引擎，返回： true：已開通。 false：未開通。	true
EnableVector	boolean	是否開通向量引擎，返回： true：已開通。 false：未開通。	true
EnableLts	boolean	是否開通 LTS 引擎，返回： true：已開通。 false：未開通。	true
EnableColumn	boolean	是否開通列存引擎，返回： true：已開通。 false：未開通。	true
EnableRow	boolean	是否開通寬表 3.0 引擎，返回： true：已開通。 false：未開通。	true
CreateErrorCode	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1,
  "InstanceList": [
    {
      "VpcId": "vpc-bp1n3i15v90el48nx****",
      "EngineType": "15",
      "ExpireTime": "2022-04-26 00:00:00",
      "CreateTime": "2021-09-16 14:13:13",
      "PayType": "PREPAY",
      "AliUid": 0,
      "InstanceStorage": "960",
      "InstanceId": "ld-bp17pwu1541ia****",
      "NetworkType": "vpc",
      "ServiceType": "lindorm",
      "RegionId": "cn-hangzhou",
      "CreateMilliseconds": 1631772842000,
      "InstanceAlias": "test",
      "ZoneId": "cn-hangzhou-h",
      "InstanceStatus": "ACTIVATION",
      "ExpiredMilliseconds": 1650902400000,
      "EnableStream": true,
      "Tags": [
        {
          "Key": "test",
          "Value": "2.2.18"
        }
      ],
      "EnableCompute": true,
      "ResourceGroupId": "rg-aekzledqeat****",
      "EnableMessage": true,
      "EnableVector": true,
      "EnableLts": true,
      "EnableColumn": true,
      "EnableRow": true,
      "CreateErrorCode": ""
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Instance.IsDeleted	The instance is deleted.	操作失敗，該執行個體已刪除。
400	Instance.IsNotAvailable	The instance is unavailable.	操作失敗，執行個體不可用。
403	Lindorm.Errorcode.OperationDenied	You are not authorized to operate on the specified resource.
403	API.Forbidden	The API operation is forbidden in this environment.	操作失敗，當前環境中該API無法使用。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。