文档

GetResourceGroup - 获取资源组详情

更新时间:

您可以通过GetResourceGroup获取资源组的详情信息。

调试

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

授权信息

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

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

请求语法

GET /api/v1/resources/{ResourceGroupID}

请求参数

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

资源组 ID,每一个资源组都有全局唯一的资源组 ID。可以通过资源组 ID 来获取资源组的信息。

rgmhpp8ib5lprq9k
IsAIWorkspaceDataEnabledboolean

这个参数是可选参数。默认是 true。

true
Tagarray<object>

对应新增标签列表,最多包含 20 个子项

object
Keystring

实例的标签键。N 的取值范围为 1~20。

TestKey
Valuestring

实例的标签值。N 的取值范围:1~20。

TestValue

返回参数

名称类型描述示例值
object

Schema of Response

GmtCreatedTimestring

ResourceGroup 创建时间。

2023-06-22T00:00:00Z
GmtModifiedTimestring

ResourceGroup 更新时间。

2023-06-22T00:00:00Z
RequestIdstring

请求 ID。

18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E
Namestring

ResourceGroup 名称。

TestResourceGroup
CreatorIDstring

ResourceGroup 创建者的 UserId。

1612285282502324
WorkspaceIDstring

工作空间 ID。

35201
Statusstring

ResourceGroup 的状态。

Ready
UserVpcUserVpc

ResourceGroup 打通 VPC 的详细信息。

ComputingResourceProviderstring

ResourceGroup 的计算资源类型。

枚举值:
  • EcsEcs
  • LingjunLingjun
ECS
ClusterIDstring

ResourceGroup 所属的集群 ID。

cb2c7bde30b774e46a329c
SupportRDMAboolean

ResourceGroup 是都支持 RDMA。

true
ResourceTypestring

ResourceGroup 的计算资源类型。

Ecs
Descriptionstring

ResourceGroup 描述信息。

testDescription
Tagsarray<object>

标签列表。

object
TagKeystring

实例的标签键。N 的取值范围为 1~20。

testKey
TagValuestring

实例的标签值。N 的取值范围:1~20。

testValue

示例

正常返回示例

JSON格式

{
  "GmtCreatedTime": "2023-06-22T00:00:00Z\n",
  "GmtModifiedTime": "2023-06-22T00:00:00Z\n",
  "RequestId": "18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E\n",
  "Name": "TestResourceGroup",
  "CreatorID": "1612285282502324",
  "WorkspaceID": "35201",
  "Status": "Ready",
  "UserVpc": {
    "VpcId": "vpc-abcdef****",
    "SwitchId": "vs-abcdef****",
    "SecurityGroupId": "sg-abcdef****",
    "ExtendedCIDRs": [
      "\"192.168.0.1/24\""
    ],
    "RoleArn": "acs:ram::25xxxx:role/AliyunPAIDLCDefaultRole",
    "DefaultRoute": "eth0"
  },
  "ComputingResourceProvider": "ECS",
  "ClusterID": "cb2c7bde30b774e46a329c",
  "SupportRDMA": true,
  "ResourceType": "Ecs",
  "Description": "testDescription",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-05-11OpenAPI 返回结构发生变更查看变更详情
2023-04-10OpenAPI 返回结构发生变更查看变更详情
2023-04-06OpenAPI 返回结构发生变更查看变更详情
2023-04-04OpenAPI 入参发生变更查看变更详情