DescribeLocationInfo API Reference for IP Geolocation - Cloud Firewall

Retrieves information about geographic locations.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	180.169.141.XXX
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
SourceCode	string	Yes	The source tracking code.	yundun

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CD3BE433-FAB0-55D8-918A-69B306****
CnCount	integer	The number of regions in China.	340
OverseasCount	integer	The number of regions outside China.	238
OverseasList	array<object>	The list of regions outside China.
	object	The list of regions outside China.
LocId	string	The ID of the region.	US
LocName	string	The name of the region.	United States
CnList	array<object>	The list of regions in China.
	object	The list of regions in China.
LocId	string	The ID of the region.	3301
LocName	string	The name of the region.	Hangzhou City
CnProvinceList	array<object>	The information about provinces and cities in China.
	array<object>	The information about provinces and cities in China.
ProvinceName	string	The name of the province.	Zhejiang
Cities	array<object>	The list of city codes.
	object	The list of city codes.
LocId	string	The ID of the region.	123
LocName	string	The name of the region.	Hangzhou

Examples

Success response

JSON format

{
  "RequestId": "CD3BE433-FAB0-55D8-918A-69B306****",
  "CnCount": 340,
  "OverseasCount": 238,
  "OverseasList": [
    {
      "LocId": "US",
      "LocName": "United States"
    }
  ],
  "CnList": [
    {
      "LocId": "3301",
      "LocName": "Hangzhou City"
    }
  ],
  "CnProvinceList": [
    {
      "ProvinceName": "Zhejiang",
      "Cities": [
        {
          "LocId": "123",
          "LocName": "Hangzhou"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorMarshalJSON	internal error.	Internal error.
400	ErrorSourceCodeError	The source code is invalid.	The source code is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.