GetResourceGroup - 查询资源组详情--机器学习平台-火山引擎

文档中心

导航

GetResourceGroup - 查询资源组详情

最近更新时间：2025.04.24 21:00:30首次发布时间：2025.04.24 21:00:30

查询资源组详情

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetResourceGroup	要执行的操作，取值：GetResourceGroup。
Version	String	是	2024-07-01	API的版本，取值：2024-07-01。
Id	String	是	r-20240923155410-*****	资源组 ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Id	String	r-20240923155410-*****	资源组 ID
Name	String	测试资源组	资源组名称
Description	String	这个资源组用于测试	资源组描述
Status	Object	.	状态
ZoneIds	Array of String	.	可用区 ID 列表
ResourceCapability	Object	.	资源总量
ResourceAllocated	Object	.	已分配资源量
ChargeType	String	PrePaid	计费模式
PeriodUnit	String	Month	购买周期单位
ExpireTime	String	2020-05-20T13:00:55Z	过期时间。遵循YYYY-MM-DD'T'HH:MM:SS'Z'格式。
RenewType	Integer	1	续费类型。1 为手动续费，2 为自动续费。
AutoRenewPeriod	Integer	1	单次自动续费续费周期数
RemainAutoRenewTimes	Integer	1	剩余续费的次数，如果为-1，则为不限制，一直进行自动续费的操作。
StorageConfig	Object	.	存储配置
WorkloadNetworkConfig	Object	.	负载私网配置

请求示例

{
	"Id": "r-20250408201328-*****"
}

返回示例

{
	"ChargeType": "PrePaid",
	"Description": "这是一个资源组",
	"ExpireTime": "2025-05-08T15:59:59Z",
	"Id": "r-20250408201328-*****",
	"Name": "资源组名称",
	"PeriodUnit": "Month",
	"RenewType": 1,
	"ResourceAllocated": {
		"ComputeResources": [
			{
				"Count": 1,
				"InstanceTypeId": "ml.g3i.16xlarge",
				"ZoneId": "cn-shanghai-b"
			}
		],
		"VolumeResources": [
			{
				"Size": 200,
				"VolumeTypeId": "ml.essd.pl1",
				"ZoneId": "cn-shanghai-b"
			}
		]
	},
	"ResourceCapability": {
		"ComputeResources": [
			{
				"Count": 2,
				"InstanceTypeId": "ml.g3i.16xlarge",
				"ZoneId": "cn-shanghai-b"
			}
		],
		"VolumeResources": [
			{
				"Size": 200,
				"VolumeTypeId": "ml.essd.pl1",
				"ZoneId": "cn-shanghai-b"
			}
		]
	},
	"Status": {
		"State": "Running"
	},
	"StorageConfig": {
		"StorageNetworkConfig": {
			"SubnetIds": [
				"subnet-3qdjzt425tqm87prml10*****"
			],
			"VpcId": "vpc-3qdjzs6imwt1c7prmkzs*****"
		}
	},
	"WorkloadNetworkConfig": {
		"SecurityGroupIds": [
			"sg-3qdjzscfq8yyo7prml00*****"
		],
		"SubnetIds": [
			"subnet-3qdjzt425tqm87prml10*****"
		],
		"VpcId": "vpc-3qdjzs6imwt1c7prmkzs*****"
	},
	"ZoneIds": [
		"cn-shanghai-b"
	]
}

错误码

您可访问公共错误码，获取更多错误码信息。