DescribeHybridProxyList - 分页查询代理机器列表 - 云安全中心

通过该接口，可以分页查询到指定代理集群已经部署的代理节点列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeHybridProxyList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterName	string	否	代理集群名称。	idc-sas-proxy
CurrentPage	integer	否	分页查询时，当前页的页码。	1
PageSize	integer	否	分页查询时，显示的每页数据的最大条数。默认值为 20。	20

返回参数

名称	类型	描述	示例值
	object
PageInfo	object	页面显示的信息。
CurrentPage	integer	分页查询时，当前页的页码。	1
PageSize	integer	分页查询时，显示的每页数据的最大条数。	20
TotalCount	integer	查询到的结果的总条数。	69
Count	integer	分页查询时，当前页显示的数据条数。	20
ProxyList	array<object>	代理集群列表信息。
List	object
InstanceId	string	资产的实例 ID。	i-uf61q03boqhhmeai1XXX
InstanceName	string	资产实例名称。	dev
InternetIp	string	服务器的公网 IP 地址。	47.76.XXX.XXX
IntranetIp	string	服务器的私网 IP 地址。	172.23.XXX.XXX
Status	string	当前代理机器运行的状态。取值： online：在线 offline：离线	online
Uuid	string	当前代理实例部署的云安全中心客户端的 UUID。	59a9d158-b2f0-4766-a893-ae67b9432721
ClientCount	integer	连接到当前代理实例的云安全中心客户端数量。	10
ProxyUuid	string	标识当前代理节点唯一的 KEY。	inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e
CurrentVersion	string	当前代理实例的版本信息。	proxy_01_05
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93

示例

正常返回示例

JSON格式

{
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69,
    "Count": 20
  },
  "ProxyList": [
    {
      "InstanceId": "i-uf61q03boqhhmeai1XXX",
      "InstanceName": "dev",
      "InternetIp": "47.76.XXX.XXX",
      "IntranetIp": "172.23.XXX.XXX",
      "Status": "online",
      "Uuid": "59a9d158-b2f0-4766-a893-ae67b9432721",
      "ClientCount": 10,
      "ProxyUuid": "inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e",
      "CurrentVersion": "proxy_01_05"
    }
  ],
  "RequestId": "75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93"
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam	Illegal param	无效参数
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

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

变更历史

变更时间	变更内容概要	操作
2024-10-31	OpenAPI 错误码发生变更	查看变更详情