ListResourceGroups - 获取资源组列表--机器学习平台-火山引擎

文档中心

导航

ListResourceGroups - 获取资源组列表

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

获取资源组列表

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListResourceGroups	要执行的操作，取值：ListResourceGroups。
Version	String	是	2024-07-01	API的版本，取值：2024-07-01。
Ids	Array of String	否	["r-20240923155410-*****"]	资源组 ID
Name	String	否	测试资源组	资源组名称
NameContains	String	否	测试	资源组名称包含
States	Array of String	否	.	状态筛选
ChargeType	String	否	PrePaid	计费模式
PageNumber	Integer	否	1	分页页码
PageSize	Integer	否	10	分页查询的每页记录数
SortBy	String	否	CreateTime	排序依据
SortOrder	String	否	Ascend	排序顺序

返回参数

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

参数	类型	示例值	描述
Items	Array of Object	.	资源组列表
TotalCount	Integer	1000	数据列表的总量
PageNumber	Integer	1	当前页码
PageSize	Integer	10	分页查询的每页记录数

请求示例

{
	"NameContains": "测试",
	"PageSize": 10,
	"SortBy": "CreateTime",
	"SortOrder": "Descend",
	"States": [
		"Running"
	]
}

返回示例

{
	"Items": [
		{
			"ChargeType": "PrePaid",
			"Description": "",
			"ExpireTime": "2025-05-08T15:59:59Z",
			"Id": "r-20250408201328-*****",
			"Name": "测试资源组1",
			"PeriodUnit": "Month",
			"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"
			]
		},
		{
			"ChargeType": "PostPaid",
			"Description": "",
			"Id": "r-20250310151441-*****",
			"Name": "测试资源组2",
			"ResourceAllocated": {
				"ComputeResources": []
			},
			"ResourceCapability": {
				"ComputeResources": [
					{
						"Count": 1,
						"InstanceTypeId": "ml.g3i.8xlarge",
						"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"
			]
		}
	],
	"PageNumber": 1,
	"PageSize": 10,
	"TotalCount": 2
}

错误码

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