DescribeNodeGroups - 查询计算组

获取节点组信息

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sr:DescribeNodeGroups

get

*全部资源

*

请求语法

POST /webapi/nodegroup/describeNodeGroups HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页查询时的页码。默认值是 1。

1

PageSize

integer

分页查询时每页的条目数。默认为 10。

20

ClusterId

string

实例 ID。

c-718fb04c7112****

body

object

请求参数信息。

instanceId

string

实例 ID。该字段已废弃。

null

componentType

string

计算组类型。包含以下取值:

  • FE

  • BE

  • CN

  • OBSERVER

  • AGENT

FE

nodeGroupIds

array

待查询的计算组 ID 列表。

string

计算组 ID。

ng-a9b2e9148196****

nodeGroupName

string

计算组名称。

ng_1

status

string

计算组状态,包含以下取值:

  • UNPAID:未支付。

  • PAID:已支付。

  • CREATING_FAILED:创建失败。

  • CREATING:创建中。

  • RUNNING:运行中。

  • MODIFYING_CONFIG:修改配置中。

  • MODIFYING_TIMEZONE:修改时区中。

  • ELASTIC_SCALING_OUT:弹性扩容中。

  • ELASTIC_SCALING_IN:弹性缩容中。

  • SCALING_OUT:扩容中。

  • RESTARTING:重启中。

  • SCALING_IN:缩容中。

  • SCALING_UP:升配中。

  • SCALING_DOWN:降配中。

  • UPGRADING:升级中。

  • ENABLE_PUBLIC_NETWORK:开通公网中。

  • DISABLE_PUBLIC_NETWORK:关闭公网中。

  • SWITCH_AZ:切换可用区中。

  • DISABLE:已禁用。

  • DELETING:删除中。

  • DELETED:已删除

RUNNING

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 请求状态码。

200

RequestId

string

请求 ID。

F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5

Success

boolean

请求是否成功。

True

ErrCode

string

错误码。

InvalidParams

ErrMessage

string

错误信息。

Invalid params: [instance not exists].

Data

array<object>

返回数据。

array<object>

返回数据。

RegionId

string

地域 ID。

cn-hangzhou

InstanceId

string

实例 ID。

c-96f3bc7f04b2****

NodeGroupId

string

计算组 ID。

ng-5e2ba600fee3****

NodeGroupName

string

计算组名称。

ng_1

Description

string

计算组描述。

ETL计算组

Status

string

计算组状态,包含以下取值:

  • UNPAID:未支付。

  • PAID:已支付。

  • CREATING_FAILED:创建失败。

  • CREATING:创建中。

  • RUNNING:运行中。

  • MODIFYING_CONFIG:修改配置中。

  • MODIFYING_TIMEZONE:修改时区中。

  • ELASTIC_SCALING_OUT:弹性扩容中。

  • ELASTIC_SCALING_IN:弹性缩容中。

  • SCALING_OUT:扩容中。

  • RESTARTING:重启中。

  • SCALING_IN:缩容中。

  • SCALING_UP:升配中。

  • SCALING_DOWN:降配中。

  • UPGRADING:升级中。

  • ENABLE_PUBLIC_NETWORK:开通公网中。

  • DISABLE_PUBLIC_NETWORK:关闭公网中。

  • SWITCH_AZ:切换可用区中。

  • DISABLE:已禁用。

  • DELETING:删除中。

  • DELETED:已删除

RUNNING

ComponentType

string

计算组类型。包含以下取值:

  • FE

  • BE

  • CN

  • OBSERVER

  • AGENT

FE

PayType

string

付费类型:

  1. 包年包月(prePaid)。

  2. 按量付费(postPaid)。

prePaid

Cu

integer

CU 数量。CU (Compute Unit) 是服务的基本计量单元,1 CU=1 核 CPU+4GiB 内存,仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。

1

MemoryCpuRatio

integer

内存大小与 CU 数量之比,SpecType 为内存增强型时值为 8,其余规格类型该比值为 4。

4

StorageSize

integer

存储大小。单位为 GiB。

100

StoragePerformanceLevel

string

云盘的性能级别。包含以下取值:

  • pl0:单盘最高随机读写 IOPS 1 万。

  • pl1:单盘最高随机读写 IOPS 5 万。

  • pl2:单盘最高随机读写 IOPS 10 万。

  • pl3:单盘最高随机读写 IOPS 100 万。

pl1

DiskNumber

integer

磁盘数量。

1

ResidentNodeNumber

integer

节点数量。

3

SpecType

string

计算组规格类型。包括以下类型:

  • standard,标准版。

  • localSSD ,本地 SSD。

  • bigData,大规格存储。

  • ramEnhanced,内存增强型。

  • networkEnhanced,网络增强型。

standard

Architecture

string

计算组架构。包含以下取值:

  • onEci,基于 ECI 部署。

  • onECS,基于 ECS 部署。

  • onBareMetal,基于裸金属资源池部署。

onEci

LocalStorageInstanceType

string

节点组本地 SSD 实例规格, 仅在基于 Ecs 实例且 SpecType 为本地 SSD/大规格存储时该值才有意义。

local_ssd_4_4xlarge

ElasticNodeNumber

integer

弹性节点数量。

3

Endpoint

string

计算组 endpoint。

be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com

EnablePublicNetwork

boolean

是否开通公网。

false

PublicAddress

string

公网地址。仅当 EnablePublicNetwork 为 true 时有值。

fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com

BeginTime

integer

计算组创建时间。

1742179008000

ExpireTime

integer

计算组到期时间。

1742179008000

DefaultGroup

boolean

是否为默认计算组。

true

RunningTime

integer

计算组已经运行的时间,单位为秒。

10000

TargetElasticNodeNumber

integer

目标弹性节点数量。

3

HttpPort

integer

计算组 Http 端口。

8030

AccountStatus

string

账户状态。包含以下取值:

  • NORMAL,账户当前处于正常状态。

  • OVERDUE,账户当前处于欠费状态。

OVERDUE

BillingInstanceId

string

帐单对应的实例 ID。对于默认计算组(FE 计算组和默认的 BE 计算组),该字段的值为实例 ID,否则为计算组 ID。

c-96f3bc7f04b2****

CommodityCode

string

商品代码。

emapreduce_starrockspost_public_cn

NodeInfo

array<object>

计算组包含的节点的信息。

object

节点信息。

NodeId

string

节点 ID。

cn-e1733d44-0

ZoneId

string

可用区 ID。

cn-hangzhou-i

Total

integer

查询结果总数。

100

AccessDeniedDetail

string

权限校验失败详情。

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "F285E0EC-E928-5E0B-B2C3-7F3FE42F2BE5",
  "Success": true,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [instance not exists].",
  "Data": [
    {
      "RegionId": "cn-hangzhou",
      "InstanceId": "c-96f3bc7f04b2****",
      "NodeGroupId": "ng-5e2ba600fee3****",
      "NodeGroupName": "ng_1",
      "Description": "ETL计算组",
      "Status": "RUNNING",
      "ComponentType": "FE",
      "PayType": "prePaid",
      "Cu": 1,
      "MemoryCpuRatio": 4,
      "StorageSize": 100,
      "StoragePerformanceLevel": "pl1",
      "DiskNumber": 1,
      "ResidentNodeNumber": 3,
      "SpecType": "standard",
      "Architecture": "onEci",
      "LocalStorageInstanceType": "local_ssd_4_4xlarge",
      "ElasticNodeNumber": 3,
      "Endpoint": "be-c-79b0bb9f58ef****-internal.starrocks.aliyuncs.com",
      "EnablePublicNetwork": false,
      "PublicAddress": "fe-c-79b0bb9f58ef****.starrocks.aliyuncs.com",
      "BeginTime": 1742179008000,
      "ExpireTime": 1742179008000,
      "DefaultGroup": true,
      "RunningTime": 10000,
      "TargetElasticNodeNumber": 3,
      "HttpPort": 8030,
      "AccountStatus": "OVERDUE",
      "BillingInstanceId": "c-96f3bc7f04b2****",
      "CommodityCode": "emapreduce_starrockspost_public_cn",
      "NodeInfo": [
        {
          "NodeId": "cn-e1733d44-0"
        }
      ],
      "ZoneId": "cn-hangzhou-i"
    }
  ],
  "Total": 100,
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

错误码

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

变更历史

更多信息,参考变更详情