HybridProxy Cluster Node Architecture Overview - Security Center - Alibaba Cloud - Security Center

Queries the list of proxy nodes that have been deployed in a specified proxy cluster by paging.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeHybridProxyList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	No	The name of the proxy cluster.	idc-sas-proxy
CurrentPage	integer	No	The number of the page to return in a paged query.	1
PageSize	integer	No	The maximum number of entries to return on each page in a paged query. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
PageInfo	object	The pagination information.
CurrentPage	integer	The number of the page to return in a paged query.	1
PageSize	integer	The maximum number of entries returned on each page in a paged query.	20
TotalCount	integer	The total number of entries returned.	69
Count	integer	The number of entries returned on the current page in a paged query.	20
ProxyList	array<object>	The proxy cluster list.
	object
InstanceId	string	The instance ID of the asset.	i-uf61q03boqhhmeai1XXX
InstanceName	string	The name of the asset instance.	dev
InternetIp	string	The public IP address of the server.	47.76.XXX.XXX
IntranetIp	string	The private IP address of the server.	172.23.XXX.XXX
Status	string	The running status of the proxy machine. Valid values: online: online offline: offline.	online
Uuid	string	The UUID of the Security Center agent deployed on the proxy instance.	59a9d158-b2f0-4766-a893-ae67b9432721
ClientCount	integer	The number of Security Center agents connected to the proxy instance.	10
ProxyUuid	string	The unique key that identifies the proxy node.	inet-proxy-3bb11fad-37d6-4aee-9c37-b0ad1612a18e
CurrentVersion	string	The version of the proxy instance.	proxy_01_05
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.	75801E5D-E2EB-5C1D-B65D-2F7D2B00EF93

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.