DescribeInstances - 查詢執行個體 - E-MapReduce

本介面用於查詢Serverless StarRocks 執行個體，支援根據執行個體名稱或標籤等資訊進行過濾。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

sr:DescribeInstances

get

*Instance

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

無

請求文法

POST /webapi/starrocks/describeInstances HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
InstanceName	string	否	執行個體名稱。	starrocks_1
InstanceId	string	否	執行個體 ID。	c-a0cb1c8ad6d35XXX
PageNumber	integer	否	查詢頁碼。	1
PageSize	integer	否	分頁查詢時，每頁包含的條目數。	10
RegionId	string	否	執行個體所屬地區 ID。	cn-hangzhou
InstanceStatus	string	否	根據執行個體狀態進行檢索，多個執行個體狀態以逗號分割，包括以下狀態：待支付（unpaid）已支付（paid）啟動中（creating）運行中（running）升級中（updating）不可用（disable）釋放中（deleting）擴容中（scaling_out）縮容中（scaling_in）升配中（scaling_up）降配中（scaling_down）版本升級中（upgrading）更新配置中（modifying_config）開通公網中（enable_public_network）關閉公網中（disable_public_network）執行個體系列升級中（convert_from_trial_to_official）叢集重啟中（restarting）叢集遷移中（migration_cluster_to_serverless）已停機（actively_disabled）恢複中（enabling） Agent 建立中（agent_creating） Agent 升配中（agent_scaling_up）	running,creating
ResourceGroupId	string	否	資源群組 ID。	rg-acfmygmtrcenXXX
Tag	array<object>	否	標籤列表。
	object	否	標籤資訊。
Key	string	否	標籤鍵。	k1
Value	string	否	標籤值。	v1

返回參數

名稱	類型	描述	樣本值
	object
HttpStatusCode	integer	HTTP 要求狀態代碼。	200
RequestId	string	請求 ID。	32A44F0D-BFF6-5664-999A-218BBDE74XXX
Success	boolean	請求是否成功。	false
Total	integer	執行個體總數。	3
ErrCode	string	錯誤碼。	InvalidParams
ErrMessage	string	錯誤資訊。	Invalid params: [instance not exists].
Data	array<object>	查詢結果。
	object	執行個體資訊。
InstanceId	string	執行個體 ID。	c-d4be777ff5e8cXXX
RegionId	string	地區 ID 。	cn-hangzhou
InstanceStatus	string	執行個體狀態。包含以下取值： not_init，未初始化 unpaid，待支付 paid，已支付 creating，建立中 creating_failed，建立失敗 created，建立成功 running，運行中 updating，升級中 agent_creating，Agent 建立中 agent_scaling_up，Agent 升配中 modifying_config，更新配置中 scaling_out，擴容中 restarting，重啟中 scaling_in，縮容中 scaling_up，升配中 scaling_down，降配中 upgrading，版本升級中 enable_public_network，開通公網中 disable_public_network，關閉公網中 convert_from_trial_to_official，版本轉換中 migration_cluster_to_serverless，叢集遷移中 modifying_timezone，修改時區中 switch_az，主備可用性區域切換中 enabling，恢複中 disable，不可用 actively_disabled，不可用 deleting，刪除中 deleting_failed，刪除失敗 deleted_with_error，建立失敗結束 deleted，已刪除	running
InstanceName	string	執行個體名稱。	sr_test_1
PackageType	string	執行個體系列。取值範圍：入門版（trial）。標準版（official）。	official
ResourceGroupId	string	資源群組 ID。	rg-acfmytyuofb****
Tags	array<object>	執行個體所綁定的標籤。
	object	標籤資訊。
Key	string	標籤鍵。	k1
Value	string	標籤值。	v1
BeginTime	integer	叢集建立時間。	1733292921000
ExpireTime	integer	叢集到期時間。	4889001600000
RunningTime	integer	叢集當前已經啟動並執行時間。單位為秒。	3645445
VSwitches	array<object>	交換器列表。
	object	交換器資訊。
ZoneId	string	可用性區域 ID。	cn-hangzhou-i
VswId	string	交換器 ID。	vsw-bp1p0mldwx5av55v0xXXX
Primary	boolean	是否為主交換器。	true
PayType	string	付費類型：訂用帳戶（prePaid）。隨用隨付（postPaid）。	postPaid
Version	string	叢集版本。	3.2
VpcId	string	VPC ID。	vpc-bp1rbvag1cafkj4prwXXX
RunMode	string	叢集的運行模式：存算一體（shared_nothing）。存算分離（shared_data）。資料湖分析（lakehouse）。	shared_nothing
MaintainablePeriod	string	執行個體可維護時間段，包括以下取值： 00:00-06:00 06:00-07:00 07:00-08:00 08:00-09:00 09:00-10:00 10:00-11:00 11:00-12:00 12:00-13:00 13:00-14:00 14:00-15:00 15:00-16:00 16:00-17:00 17:00-18:00 18:00-19:00 19:00-20:00 20:00-21:00 21:00-22:00 22:00-23:00 23:00-24:00	00:00-06:00
MinorVersion	string	小版本版本號碼。	3.2.11-1.79-1.6.5
EnableAutoMinorVersionUpgrade	boolean	是否允許自動小版本升級	true
EnabledAuditLoader	boolean	是否開啟審計外掛程式。	true
MonitorType	string	監控服務類型。	cms
Architecture	string	執行個體架構。包含以下取值： onEci，基於 ECI 部署。 onECS，基於 ECS 部署。 onBareMetal，基於裸金屬資源集區部署。	onECS
AclId	string	網路 ACL（Network Access Control List）ID。	acl-bp1xc6b9vs013jjtp****
SgId	string	安全性群組 ID。	sg-8vbaz2etr66a62b9****
OssLocation	string	OSS 地址。	oss://sr-c-****
SecurityGroupManaged	boolean	是否託管安全性群組。	true
IsolateLeader	boolean	是否開啟讀寫分離（Leader FE 節點處理寫請求，其餘節點處理讀請求）。	true
EnableSSL	boolean	是否開啟 SSL。	true
Encrypted	boolean	是否加密。	true
KmsKeyId	string	KMS 金鑰識別碼。	rewqfds****

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "32A44F0D-BFF6-5664-999A-218BBDE74XXX\n",
  "Success": false,
  "Total": 3,
  "ErrCode": "InvalidParams\n",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": [
    {
      "InstanceId": "c-d4be777ff5e8cXXX",
      "RegionId": "cn-hangzhou",
      "InstanceStatus": "running",
      "InstanceName": "sr_test_1",
      "PackageType": "official",
      "ResourceGroupId": "rg-acfmytyuofb****",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "BeginTime": 1733292921000,
      "ExpireTime": 4889001600000,
      "RunningTime": 3645445,
      "VSwitches": [
        {
          "ZoneId": "cn-hangzhou-i",
          "VswId": "vsw-bp1p0mldwx5av55v0xXXX",
          "Primary": true
        }
      ],
      "PayType": "postPaid",
      "Version": "3.2",
      "VpcId": "vpc-bp1rbvag1cafkj4prwXXX",
      "RunMode": "shared_nothing",
      "MaintainablePeriod": "00:00-06:00",
      "MinorVersion": "3.2.11-1.79-1.6.5",
      "EnableAutoMinorVersionUpgrade": true,
      "EnabledAuditLoader": true,
      "MonitorType": "cms",
      "Architecture": "onECS",
      "AclId": "acl-bp1xc6b9vs013jjtp****",
      "SgId": "sg-8vbaz2etr66a62b9****",
      "OssLocation": "oss://sr-c-****",
      "SecurityGroupManaged": true,
      "IsolateLeader": true,
      "EnableSSL": true,
      "Encrypted": true,
      "KmsKeyId": "rewqfds****"
    }
  ]
}

錯誤碼

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

變更歷史

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