全部产品
Search
文档中心

云安全中心:DescribeHybridProxyClusterList - 分页查询代理集群列表

更新时间:Nov 25, 2024

分页查询代理集群列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:DescribeHybridProxyClusterListget
*全部资源
*

请求参数

名称类型必填描述示例值
ClusterNamestring

代理集群名称。

test
CurrentPageinteger

分页查询时,显示的当前页的页码。

1
PageSizeinteger

分页查询时,显示的每页数据的最大条数。

20

返回参数

名称类型描述示例值
object
ClusterListarray<object>

集群列表

Listobject

集群列表

ClusterNamestring

代理集群名称。

idc-sas-proxy
ProxyCountinteger

代理节点数量。

3
ClientCountinteger

当前集群接入云安全中心客户端数量。

10
Remarkstring

代理集群备注信息。

test
InstallCommandstring

当前代理集群节点的安装命令。

test
AuthKeystring

集群认证的凭据 ID。

test
AuthKeySecretstring

集群认证的凭证 KEY。

test
Statusstring

集群运行状态。

offline
Ipstring

集群接入地址,IP 或者域名。

114.115.XXX.XXX
LastHeartTimelong

集群上次心跳在线时间戳。单位毫秒。

1608304654000
PageInfoobject

页面显示信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页最多显示的数据条数。

20
TotalCountinteger

查询结果的总数。

45
Countinteger

当前页显示的查询项条数。

20
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

C1A36413-50B2-5B2F-843F-EB14C582713F

示例

正常返回示例

JSON格式

{
  "ClusterList": [
    {
      "ClusterName": "idc-sas-proxy",
      "ProxyCount": 3,
      "ClientCount": 10,
      "Remark": "test",
      "InstallCommand": "test",
      "AuthKey": "test",
      "AuthKeySecret": "test",
      "Status": "offline",
      "Ip": "114.115.XXX.XXX",
      "LastHeartTime": 1608304654000
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 20
  },
  "RequestId": "C1A36413-50B2-5B2F-843F-EB14C582713F"
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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