使用DescribeInstances查询Serverless StarRocks实例-开源大数据平台 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 密钥 ID。	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****"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。