GetResources - 获取集群/节点资源实时使用情况 - Alibaba Cloud Linux

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:GetBasicResources

get

*全部资源

*

无

请求语法

GET /api/v1/openapi/cluster_health/instant/resource HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
cluster	string	否	集群 id	1808078950770264
instance	string	否	实例 ID。	i-wz9d00ut2ska3mlyhn6j
type	string	否	资源类型枚举值：上行速率 : network_input 下行速率 : network_output 磁盘 : disk 内存 : mem CPU : cpu	mem

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	object	返回数据。
total	number	资源总数	2354
unit	string	单位	Kbytes
usage	number	资源使用量	100
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	result: code=1 msg=(Request failed, status_code != 200)
request_id	string	请求 RequestId	35F91AAB-5FDF-5A22-B211-C7C6B00817D0

示例

正常返回示例

JSON格式

{
  "code": "Success",
  "data": {
    "total": 2354,
    "unit": "Kbytes",
    "usage": 100
  },
  "message": "result: code=1 msg=(Request failed, status_code != 200)",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。