GetResourceGroup API的请求与返回参数-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

pai:GetResourceGroup

get

*ResourceGroup

acs:pai:{#regionId}:{#accountId}:resourcegroup/{#ResourceGroupId}

无

请求语法

GET /api/v1/resources/{ResourceGroupID} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
ResourceGroupID	string	是	资源组 ID，每一个资源组都有全局唯一的资源组 ID。可以通过资源组 ID 来获取资源组的信息。	rgmhpp8ib5lprq9k

请求参数

名称	类型	必填	描述	示例值
IsAIWorkspaceDataEnabled	boolean	否	这个参数是可选参数。默认是 true。	true
Tag	array<object>	否	对应新增标签列表，最多包含 20 个子项
	object	否
Key	string	否	实例的标签键。N 的取值范围为 1~20。	TestKey
Value	string	否	实例的标签值。N 的取值范围：1~20。	TestValue

返回参数

名称	类型	描述	示例值
	object	Schema of Response
GmtCreatedTime	string	ResourceGroup 创建时间。	2023-06-22T00:00:00Z
GmtModifiedTime	string	ResourceGroup 更新时间。	2023-06-22T00:00:00Z
RequestId	string	请求 ID。	18D5A1C6-14B8-545E-8408-0A7DDB4C6B5E
Name	string	ResourceGroup 名称。	TestResourceGroup
CreatorID	string	ResourceGroup 创建者的 UserId。	1612285282502324
WorkspaceID	string	工作空间 ID。	35201
Status	string	ResourceGroup 的状态。	Ready
UserVpc	UserVpc	ResourceGroup 打通 VPC 的详细信息。
ComputingResourceProvider	string	ResourceGroup 的计算资源类型。枚举值： Ecs : Ecs Lingjun : Lingjun	ECS
ClusterID	string	ResourceGroup 所属的集群 ID。	cb2c7bde30b774e46a329c
SupportRDMA	boolean	ResourceGroup 是都支持 RDMA。	true
ResourceType	string	ResourceGroup 的计算资源类型。	Ecs
Description	string	ResourceGroup 描述信息。	testDescription
Tags	array<object>	标签列表。
	object
TagKey	string	实例的标签键。N 的取值范围为 1~20。	testKey
TagValue	string	实例的标签值。N 的取值范围：1~20。	testValue
Version	string

示例

正常返回示例

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",
    "DefaultForwardInfo": {
      "NatGatewayId": "nat-7j4mka9wguxj",
      "EipAllocationId": "eip-h29r78ieufbih"
    }
  },
  "ComputingResourceProvider": "ECS",
  "ClusterID": "cb2c7bde30b774e46a329c",
  "SupportRDMA": true,
  "ResourceType": "Ecs",
  "Description": "testDescription",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ],
  "Version": ""
}

错误码

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

变更历史

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