Proxy Cluster Data Collection API Reference - Security Center - Alibaba Cloud - Security Center

Queries the data collection configuration of a specified proxy cluster.

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:DescribeHybridProxyPolicy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterName	string	Yes	The name of the proxy cluster. You can view the cluster name in the console.	test-idc

Response elements

Element	Type	Description	Example
	object	ListResult
PolicyList	array<object>	The list of data collection configurations for the proxy cluster.
	array<object>
PolicyType	string	The policy type. Valid values: limitFrequency: collection frequency control limitBandWidth: collection bandwidth control.	limitBandWidth
Info	array<object>	The policy information.
	object
Type	string	The type of the policy that you configured. Valid values: file net process	file
Config	string	The value of the policy configurations.	10
FileName	string	The name of the file. After you configure a blocking policy, the blocked data is written to the file.	test
Count	integer	The number of entries returned on the current page in a paged query.	1
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.	F7A1B40A-7EED-55A0-BCBC-2F83A486F0AB

Examples

Success response

JSON format

{
  "PolicyList": [
    {
      "PolicyType": "limitBandWidth",
      "Info": [
        {
          "Type": "file",
          "Config": "10",
          "FileName": "test"
        }
      ]
    }
  ],
  "Count": 1,
  "RequestId": "F7A1B40A-7EED-55A0-BCBC-2F83A486F0AB"
}

Error codes

HTTP status code	Error code	Error message	Description
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.