ListResourceGroups - 获取资源组列表

您可以通过该接口获取通用计算资源或灵骏智算资源的资源组列表。

接口说明

目前,AI 计算资源组(包括通用计算资源和灵骏智算资源)仅在部分地域提供服务。具体支持的地域列表,请参见 AI 计算资源管理

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pai:ListResourceGroupslist
*全部资源
*

请求语法

GET /api/v1/resources HTTP/1.1

请求参数

名称类型必填描述示例值
Namestring

Resource Group 名称。

rgf0zhfqn1d4ity2
PageNumberlong

分页数。

2
PageSizelong

页面容量。

10
Orderstring

排序顺序。取值如下:

  • desc:降序。
  • asc:升序。
desc
SortBystring

用于排序的字段名,可选字段名:DisplayName、GmtCreated、GmtModified、RegionID、Duration、PricingCycle、PayType。

DisplayName
Statusstring

Resource Group 的状态。

Creating
ShowAllboolean

是否全部返回。

false
ComputingResourceProviderstring

Resource Group 的计算资源类型。

Ecs
ResourceTypestring

资源类型列表。取值如下:

  • ECS:通用计算资源。
  • Lingjun:灵骏智算资源。
Lingjun

返回参数

名称类型描述示例值
object

返回结果。

ResourceGroupsarray

资源组列表。

ResourceGroupsResourceGroup

资源组。

TotalCountlong

查询到的资源组的数量。

2
RequestIdstring

请求 ID。

9CFA2665-1FFE-5929-8468-C14C25890486

示例

正常返回示例

JSON格式

{
  "ResourceGroups": [
    {
      "Name": "RG1",
      "ResourceGroupID": "rg17tmvwiokh****",
      "WorkspaceID": "23000",
      "UserVpc": {
        "VpcId": "vpc-abcdef****",
        "SwitchId": "vs-abcdef****",
        "SecurityGroupId": "sg-abcdef****",
        "ExtendedCIDRs": [
          "\"192.168.0.1/24\""
        ],
        "RoleArn": "acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole",
        "DefaultRoute": "eth0",
        "DefaultForwardInfo": {
          "NatGatewayId": "nat-7j4mka9wguxj",
          "EipAllocationId": "eip-h29r78ieufbih"
        }
      },
      "GmtCreatedTime": "2023-06-22T00:00:00Z",
      "GmtModifiedTime": "2023-06-22T00:00:00Z",
      "CreatorID": "161228528250****",
      "NodeCount": 3
    }
  ],
  "TotalCount": 2,
  "RequestId": "9CFA2665-1FFE-5929-8468-C14C25890486"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-11OpenAPI 入参发生变更查看变更详情
2023-04-26OpenAPI 入参发生变更查看变更详情