文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 云办公服务/ 查询边缘小站列表 - ListWksEdgeSites
更新时间：2026-03-17 GMT+08:00
查看PDF
分享

查询边缘小站列表 - ListWksEdgeSites

功能介绍

查询边缘小站列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/wks-edge-sites

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

根据边缘小站名称查询。

availability_zone_id

否

String

根据边缘可用区ID查询。

status

否

String

根据边缘小站部署状态查询。

limit

否

Integer

每页数量，范围0-1000，默认1000。

offset

否

Integer

偏移量，默认0。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

wks_edge_sites

Array of WksEdgeSiteDetail objects

边缘小站列表。

total_count

Integer

站点总数。
表4 WksEdgeSiteDetail

参数

参数类型

描述

id

String

边缘小站id。

name

String

边缘小站名称。

description

String

边缘小站描述。

availability_zone_id

String

边缘小站的可用区ID。

address

String

部署位置。

status

String

边缘小站的部署状态。

  • initial：待部署。

  • deploying：部署中。

  • available：可用。

  • unavailable：不可用。

created_at

String

边缘小站创建时间。

updated_at

String

边缘小站更新时间。

cpu_usage_rate

Double

cpu使用率。

memory_usage_rate

Double

内存使用率。

capacity_usage_rate

Double

存储使用率。

site_info

SimpleSiteInfo object

站点信息。
表5 SimpleSiteInfo

参数

参数类型

描述

id

String

云桌面边缘小站id。

status

String

云办公服务的状态。

  • PREPARING：准备开通。

  • SUBSCRIBING：开通中。

  • SUBSCRIBED：已开通。

  • SUBSCRIPTION_FAILED：开通失败。

  • DEREGISTERING：销户中。

  • DEREGISTRATION_FAILED：销户失败。

  • CLOSED：已销户未开通。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/fb2e5ec048384c8f9469d22db0037908/wks-edge-sites

响应示例

状态码：200

查询边缘小站列表的接口响应。

{
  "wks_edge_sites" : [ {
    "id" : "string",
    "name" : "string",
    "description" : "string",
    "availability_zone_id" : "string",
    "address" : "string",
    "status" : "string",
    "created_at" : "string",
    "updated_at" : "string",
    "cpu_usage_rate" : 0,
    "memory_usage_rate" : 0,
    "capacity_usage_rate" : 0,
    "site_info" : {
      "id" : "string",
      "status" : "string"
    }
  } ],
  "total_count" : 0
}

状态码

状态码

描述

200

查询边缘小站列表的接口响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 云办公服务