DescribeIpAbroadCountryInfos - Web Application Firewall - Alibaba Cloud Documentation Center

Retrieves supported countries and regions outside China for IP-based region blacklist.

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-waf:DescribeIpAbroadCountryInfos

list

*All Resource

*

acs:ResourceGroupId

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the current WAF instance ID.	waf_elasticity-cn-0xl*******005
Country	string	No	The country outside China to query. Supports fuzzy query by country ID or country name in Chinese or English.	US
AbroadRegion	string	No	The region outside China to query. Supports fuzzy query by region ID or region name in Chinese or English.	US-CA
NextToken	string	No	The token for the next page. Set this parameter to the value of the NextToken parameter returned from the previous API call. You do not need to specify this parameter for the first page query.	caeba0bbb2be03f84eb48b699f0*****
MaxResults	integer	No	The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 20.	20
Language	string	No	The language used for country and region names in the response. Valid values: en (default): English. cn: Simplified Chinese.	en
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: The Chinese mainland. ap-southeast-1: Outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aekzwwk****cv5i

Response elements

Element	Type	Description	Example
	object	Response body structure
RequestId	string	The request ID	66A98669-CC6E-4F3E-80A6-3014697B11AE
TotalCount	integer	The total number of entries returned.	2
AbroadInfos	array<object>	The list of country information outside China.
	array<object>
Country	string	The ID of the country.	US
CountryName	string	The name of the country.	United States
Regions	array<object>	The list of region information outside China.
	object	The region information outside China.
AbroadRegionId	string	The ID of the region.	US-CA
AbroadRegionName	string	The name of the region.	California
Continent	string	The continent to which the country belongs.	North America
NextToken	string	The token for the next page.	caeba0bbb2be03f84eb48b699f0*****
MaxResults	integer	The number of entries per page in a paged query. Valid values: 1 to 500. Default value: 20.	20

Examples

Success response

JSON format

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "TotalCount": 2,
  "AbroadInfos": [
    {
      "Country": "US",
      "CountryName": "United States",
      "Regions": [
        {
          "AbroadRegionId": "US-CA",
          "AbroadRegionName": "California"
        }
      ],
      "Continent": "North America"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0*****",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.