All Products
Search
Document Center

Security Center:DescribeHybridProxyClusterList

Last Updated:Oct 24, 2025

Queries proxy clusters by page.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeHybridProxyClusterListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterNamestringNo

The name of the proxy cluster.

test
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object
ClusterListarray<object>

The proxy clusters.

Listobject

The information about the proxy cluster.

ClusterNamestring

The name of the proxy cluster.

idc-sas-proxy
ProxyCountinteger

The number of proxy nodes.

3
ClientCountinteger

The number of servers that are connected to the proxy cluster.

10
Remarkstring

The description of the proxy cluster.

test
InstallCommandstring

The installation command for the node of the proxy cluster.

test
AuthKeystring

The ID of the credential that is used for cluster authentication.

test
AuthKeySecretstring

The key of the credential that is used for cluster authentication.

test
Statusstring

The status of the cluster.

offline
Ipstring

The endpoint of the cluster. An IP address or a domain name is specified.

114.115.XXX.XXX
LastHeartTimelong

The timestamp when the cluster last sent a heartbeat message. Unit: milliseconds.

1608304654000
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

45
Countinteger

The number of entries on the current page.

20
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

{
  "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"
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.