Retrieve Domain Custom Headers via DescribeHeaders API-Anti - DDoS Pro - Alibaba Cloud - Anti-DDoS

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-ddoscoo:DescribeHeaders

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group in Resource Management to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs. This parameter is empty by default, which indicates that the instance belongs to the default resource group.	rg-aek3cmuvpia****
Domain	string	Yes	The domain name for which to query custom headers. Note You can call the DescribeDomains operation to query all domain names.	example.aliyundoc.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	48BC7BA5-69BE-5C31-A080-AFF2431AE48D
CustomHeader	object	The custom header information.
Headers	string	The custom headers. The value is a string that consists of a JSON object. The JSON object contains the following fields:	{"X-Forwarded-ClientSrcPort":"","header1":"hLeLele"}
Domain	string	The domain name of the website.	example.aliyundoc.com
EmbeddedHeaders	string	The request header that can be used to mark the Layer 7 attack. The value is a string that consists of a JSON object. The JSON object contains the following fields:	{"X-Client-IP":true,"X-True-IP":true,"Web-Server-Type":true,"WL-Proxy-Client-IP":true,"X-Forwarded-Proto":true}

Examples

Success response

JSON format

{
  "RequestId": "48BC7BA5-69BE-5C31-A080-AFF2431AE48D",
  "CustomHeader": {
    "Headers": "{\"X-Forwarded-ClientSrcPort\":\"\",\"header1\":\"hLeLele\"}",
    "Domain": "example.aliyundoc.com"
  },
  "EmbeddedHeaders": "{\"X-Client-IP\":true,\"X-True-IP\":true,\"Web-Server-Type\":true,\"WL-Proxy-Client-IP\":true,\"X-Forwarded-Proto\":true}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.