All Products
Search
Document Center

Security Center:DescribeHybridProxyList

Last Updated:Jan 20, 2026

Queries the proxy nodes that are deployed in a proxy cluster 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:DescribeHybridProxyListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterNamestringNo

The name of the proxy cluster.

idc-sas-proxy
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

69
Countinteger

The number of entries on the current page.

20
ProxyListarray<object>

The information about the proxy clusters.

Listobject
InstanceIdstring

The instance ID.

i-uf61q03boqhhmeai1XXX
InstanceNamestring

The instance name.

dev
InternetIpstring

The public IP address of the server.

47.76.XXX.XXX
IntranetIpstring

The private IP address of the server.

172.23.XXX.XXX
Statusstring

The status of the proxy server. Valid values:

  • online
  • offline
online
Uuidstring

The UUID of the server that is connected to the proxy instance.

59a9d158-b2f0-4766-a893-ae67b943XXXX
ClientCountinteger

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

10
ProxyUuidstring

The UUID of the proxy node.

inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e
CurrentVersionstring

The version of the proxy instance.

proxy_01_05
RequestIdstring

The request ID.

75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93

Examples

Sample success responses

JSONformat

{
  "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-ae67b943XXXX",
      "ClientCount": 10,
      "ProxyUuid": "inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e",
      "CurrentVersion": "proxy_01_05"
    }
  ],
  "RequestId": "75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93"
}

Error codes

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

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

Change history

Change timeSummary of changesOperation
2024-10-31The Error code has changedView Change Details