获得资源池详细信息
功能介绍
获得资源池详细信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
cluster_id |
是 |
String |
参数解释: 集群ID。获取方法请参见获取集群ID。 约束限制: 必须是有效的dws集群ID。 取值范围: 36位UUID。 默认取值: 不涉及。 |
queue_name |
是 |
String |
参数解释: 资源池名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logical_cluster_name |
否 |
String |
参数解释: 逻辑集群名称。非逻辑集群模式下该字段不填,逻辑集群模式下需指定逻辑集群名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
workload_res_code |
Integer |
参数解释: 结果状态码。 取值范围: 不涉及。 |
workload_res_str |
String |
参数解释: 结果描述。 取值范围: 不涉及。 |
workload_queue |
WorkloadQueueItem object |
参数解释: 资源队列段详情。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
queue_name |
String |
参数解释: 资源池名称。 取值范围: 不涉及。 |
logical_cluster_name |
String |
参数解释: 逻辑集群名称。 取值范围: 不涉及。 |
short_query_optimize |
String |
参数解释: 资源池短查询加速开关。 取值范围: 不涉及。 |
short_query_concurrency_num |
Integer |
参数解释: 资源池短查询并发数。 取值范围: 不涉及。 |
resource_item_list |
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/queues/resource1
响应示例
状态码:200
获得资源池详细信息成功。
{ "workload_queue" : { "queue_name" : "resource1", "logical_cluster_name" : "", "short_query_optimize" : "t", "short_query_concurrency_num" : -1, "resource_item_list" : [ { "resource_name" : "cpu", "resource_value" : 1, "value_unit" : null, "resource_description" : null } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
获得资源池详细信息成功。 |
400 |
请求错误。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误。 |
503 |
服务不可用。 |