运行状态统计 - ListRunState
功能介绍
租户桌面运行状态统计。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:statistics:getRunState
Read
-
-
-
-
URI
GET /v2/{project_id}/desktops/statistics/run-state
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
stop_num |
Integer |
停止个数。 |
|
active_num |
Integer |
运行中个数。 |
|
error_num |
Integer |
故障个数。 |
|
hibernated_num |
Integer |
休眠个数。 |
状态码：default
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
GET /v2/9565be6e740941c493b38a1f46ecae6f/desktops/statistics/run-state
响应示例
状态码：200
桌面运行状态统计响应。
{
"stop_num" : 0,
"active_num" : 5,
"error_num" : 0,
"hibernated_num" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
桌面运行状态统计响应。 |
|
default |
错误响应。 |
错误码
请参见错误码。
