查询资源管理计划列表
功能介绍
查询集群中所有资源管理计划。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/workload/plans
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| cluster_id | 是 | String | 参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| logical_cluster_name | 否 | String | 参数解释: 逻辑集群名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 分页单页大小。 约束限制: 不涉及。 取值范围: 大于0。 默认取值: 10 |
| offset | 否 | Integer | 参数解释: 分页偏移量,从0开始,页数减1。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| workload_res_code | Integer | 参数解释: 结果状态码。 取值范围: 不涉及。 |
| workload_res_str | String | 参数解释: 结果描述。 取值范围: 不涉及。 |
| plan_list | Array of WorkloadPlanInfo objects | 参数解释: 资源池名称。 取值范围: 不涉及。 |
| count | Integer | 参数解释: 总数量。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | Integer | 参数解释: 计划状态。 取值范围: 不涉及。 |
| project_id | String | 参数解释: 项目ID。 取值范围: 不涉及。 |
| cluster_id | String | 参数解释: 集群ID。 取值范围: 36位UUID。 |
| plan_id | String | 参数解释: 计划ID。 取值范围: 不涉及。 |
| plan_name | String | 参数解释: 计划名称。 取值范围: 不涉及。 |
| current_stage | String | 参数解释: 当前计划阶段。 取值范围: 不涉及。 |
| logical_cluster_name | String | 参数解释: 逻辑集群名称。 取值范围: 不涉及。 |
| stage_list | Array of PlanStage objects | 参数解释: 计划阶段列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| month | String | 参数解释: 计划月份。 取值范围: 不涉及。 |
| day | String | 参数解释: 计划日期。 取值范围: 不涉及。 |
| plan_id | String | 参数解释: 计划ID。 取值范围: 不涉及。 |
| stage_id | String | 参数解释: 计划阶段ID。 取值范围: 不涉及。 |
| stage_name | String | 参数解释: 计划阶段名称。 取值范围: 不涉及。 |
| start_time | String | 参数解释: 计划开始时间。 取值范围: 不涉及。 |
| end_time | String | 参数解释: 计划结束时间。 取值范围: 不涉及。 |
| next_valid_time | String | 参数解释: 下次校验时间。 取值范围: 不涉及。 |
| queue_list | Array of QueueResourceItem objects | 参数解释: 资源队列列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| queue_name | String | 参数解释: 资源池名称。 取值范围: 不涉及。 |
| queue_resources | Array of WorkloadResourceItem objects | 参数解释: 资源配置队列。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_name | String | 参数解释: 资源名称。 约束限制: 不涉及。 取值范围: cpu:占用CPU时间片的百分比。 cpu_limit:使用CPU物理核数的百分比。 memory:指每个数据节点上可用内存资源的百分比。 concurrency:并发数。 shortQueryConcurrencyNum:简单语句并发数。 weight:网络调度时权重值。 默认取值: 不涉及。 |
| resource_value | Integer | 参数解释: 资源属性值。 约束限制: 不涉及。 取值范围: 根据配置不同,取值范围不同 cpu:取值范围为1~99的整数。 cpu_limit:取值范围为0~100的整数,0表示不限制。 memory:取值范围为0~100的整数,0表示不管控。 concurrency:取值范围为-1~2147483647的整数,-1/0表示不限制。 shortQueryConcurrencyNum:取值范围为-1~2147483647的整数,-1/0表示不管控。 weight:取值范围为1~2147483647的整数,默认配置为-1。 默认取值: 不涉及。 |
| value_unit | String | 参数解释: 资源属性单位。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_description | String | 参数解释: 资源附加描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
查询集群中所有资源管理计划。
GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans 响应示例
状态码:200
查询成功。
{
"plan_list" : [ {
"status" : 0,
"cluster_id" : "862201cd-f822-4dbc-ae3b-c7b9d080eea6",
"project_id" : "0536cdee2200d5912f7cc00b877980f1",
"plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
"plan_name" : "plan1",
"current_stage" : null,
"logical_cluster_name" : null,
"stage_list" : null
} ],
"count" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功。 |
| 400 | 请求错误。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 500 | 服务内部错误。 |
| 503 | 服务不可用。 |