QueryBusinessLocations - Microservices Engine - Alibaba Cloud Documentation Center

Queries information about regions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
Message	string	The message returned.	The parameter is invalid.
RequestId	string	The ID of the request.	3369AD10-F1A6-4E6F-B99E-20F51826****
Data	array<object>	The details of the data.
LocationData	object	The returned information.
Ordering	integer	The ordering information.	6
Type	string	The type.	region
DistrictEnName	string	The English name of the district.	Asia Pacific
ShowName	string	The display name.	China (Shanghai)
DistrictCnName	string	The Chinese name of the district.	Asia Pacific
EnName	string	The English name of the region.	China (Shanghai)
DistrictId	string	The ID of the region.	asia-pacific
DistrictShowName	string	The display name of the district.	Asia Pacific
Description	string	The description.	China (Shanghai)
EnDescription	string	The complete description of the region.	China East 2 (Shanghai)
CnName	string	The Chinese name of the region.	China (Shanghai)
Name	string	The name.	cn-shanghai
DistrictOrdering	integer	The ordering information of the district.	101
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	string	The result of the request.	true

Examples

Sample success responses

JSONformat

{
  "Message": "The parameter is invalid.\n",
  "RequestId": "3369AD10-F1A6-4E6F-B99E-20F51826****",
  "Data": [
    {
      "Ordering": 6,
      "Type": "region",
      "DistrictEnName": "Asia Pacific",
      "ShowName": "China (Shanghai)\n",
      "DistrictCnName": "Asia Pacific\n",
      "EnName": "China (Shanghai)",
      "DistrictId": "asia-pacific",
      "DistrictShowName": "Asia Pacific\n",
      "Description": "China (Shanghai)\n",
      "EnDescription": "China East 2 (Shanghai)",
      "CnName": "China (Shanghai)\n",
      "Name": "cn-shanghai",
      "DistrictOrdering": 101
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-24	The internal configuration of the API is changed, but the call is not affected	View Change Details