DescribeCdnLinkageRules - Anti-DDoS - Alibaba Cloud Documentation Center

Describes the CDN interaction rule configurations for a specified domain name.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the Anti-DDoS instance belongs in Resource Management. If you leave this parameter empty, the instance belongs to the default resource group.	default
Domain	string	No	The domain name of your website. Note The domain name must be added to your Anti-DDoS instance. Call DescribeDomains to query all domain names.	example.aliyundoc.com
PageNumber	integer	Yes	The number of the page to return for a paged query.	1
PageSize	integer	Yes	The number of entries to return on each page for a paged query.	10

Response elements

Element	Type	Description	Example
	object
TotalCount	string	The total number of entries returned.	12
RequestId	string	The ID of the request.	02FE96D9-C77B-5735-B36D-329E052C8047
SchedulerRules	array<object>	The traffic scheduling rules.
	array<object>	The traffic scheduling rules.
Domain	string	The domain name.	example.aliyundoc.com
CdnLinkageEnable	integer	Specifies whether CDN interaction is enabled. Valid values: 0: Disabled 1: Enabled	0
CdnLinkageRule	object	The CDN interaction rule.
Cname	string	The canonical name of the Anti-DDoS instance that is associated with the domain name.	example.aliyundoc.com
RuleName	string	The name of the traffic scheduling rule.	testDDos
Rules	array<object>	The rule information.
	object
Type	string	The format of the resource address. Valid values: A: IPv4 address AAAA: IPv6 address CNAME: canonical name	A
Status	integer	The status of the rule. Valid values: 0: Inactive 1: Active	1
Value	string	The resource address.	203.107.XX.XX
ValueType	integer	The type of the resource address. Valid values: 1: Anti-DDoS IP 5: Accelerated domain name for CDN interaction	1
Priority	integer	The priority of the rule. Valid values: 0 to 100. A larger value indicates a higher priority.	1
RegionId	string	The region ID. The default value is empty.	""
Param	object	The resource for interaction.
ParamType	string	The type of the resource for interaction. Valid values: cdn: Alibaba Cloud CDN dcdn: DCDN	cdn
ParamData	object	The interaction conditions.
AccessQps	integer	The QPS threshold that triggers a resource switch.	100
UpstreamQps	integer	A reserved field. The default value is 0.	0

Examples

Success response

JSON format

{
  "TotalCount": "12",
  "RequestId": "02FE96D9-C77B-5735-B36D-329E052C8047",
  "SchedulerRules": [
    {
      "Domain": "example.aliyundoc.com\n",
      "CdnLinkageEnable": 0,
      "CdnLinkageRule": {
        "Cname": "example.aliyundoc.com\n",
        "RuleName": "testDDos",
        "Rules": [
          {
            "Type": "A",
            "Status": 1,
            "Value": "203.107.XX.XX",
            "ValueType": 1,
            "Priority": 1,
            "RegionId": "\"\""
          }
        ],
        "Param": {
          "ParamType": "cdn",
          "ParamData": {
            "AccessQps": 100,
            "UpstreamQps": 0
          }
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.