You need to enable JavaScript to run this app.
导航
机器学习平台
  • 文档首页
    • /机器学习平台/API 参考/预约计划/ListResourceReservationPlans - 获取预约计划列表
ListResourceReservationPlans - 获取预约计划列表
最近更新时间：2025.08.09 19:15:03首次发布时间：2025.08.09 19:15:03
复制全文
我的收藏
有用
有用
无用
无用

获取预约计划列表

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String
是

ListResourceReservationPlans

要执行的操作，取值：ListResourceReservationPlans。

Version
String
是

2024-07-01

API的版本，取值：2024-07-01。

Ids
Array of String
否

["rp-20240923155410-*****"]

预约计划 ID 列表

Name
String
否

测试预约计划

预约计划名称

NameContains
String
否

测试

预约计划名称包含

States
Array of String
否

["Running"]

状态筛选

ReservationTypes
Array of String
否

["Recurring"]

预约计划预约类型

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

分页查询的每页记录数

请求示例

{
	"Ids": [
		"rp-20250603174855-f8fb8"
	],
	"NameContains": "测试",
	"PageNumber": 1,
	"PageSize": 100,
	"SortBy": "CreateTime",
	"States": [
		"Running"
	]
}

返回示例

{
	"Items": [
		{
			"CreateTime": "2025-06-03T09:48:55Z",
			"CreatorTrn": "trn:iam::*****:user/*****@bytedance.com",
			"Description": "这是一个周期型的预约计划",
			"DesiredComputeResource": {
				"Count": 5,
				"InstanceTypeId": "ml.gni3cl.5xlarge",
				"ZoneIds": [
					"cn-beijing2-c"
				]
			},
			"Id": "rp-20250603174855-*****",
			"Name": "测试创建周期型预约计划",
			"ReservationConfig": {
				"MaxDurationHours": 12,
				"MinDurationHours": 4,
				"RecurrenceEndTime": "2025-06-03T16:00:00Z",
				"RecurrenceInterval": "Daily",
				"RecurrenceStartTime": "2025-06-03T16:00:00Z",
				"ReservationType": "Recurring"
			},
			"Status": {
				"State": "Running"
			},
			"StorageConfig": {
				"StorageNetworkConfig": {
					"SubnetIds": [
						"subnet-2570xujprd88w4a7cfen*****"
					],
					"VpcId": "vpc-2zdi3b2l2lse8610wgmd*****"
				},
				"Vepfs": {
					"FileSystemIds": [
						"vepfs-cnbj25b3d56c*****"
					],
					"PrefetchEnabled": false
				}
			},
			"UpdateTime": "2025-06-03T09:49:16Z",
			"WorkloadNetworkConfig": {
				"SecurityGroupIds": [
					"sg-2zdi3b8i5xybk610wgno*****"
				],
				"SubnetIds": [
					"subnet-2570xujprd88w4a7cfen*****"
				],
				"VpcId": "vpc-2zdi3b2l2lse8610wgmd*****"
			}
		}
	],
	"PageNumber": 1,
	"PageSize": 100,
	"TotalCount": 1
}

错误码

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