ListUserDefineRegion - Enterprise Distributed Application Service

Queries a list of user-defined namespaces.

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

edas:ListUserDefineRegion

list

*All Resource

*

None

Request syntax

POST /pop/v5/user_region_defs HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DebugEnable	boolean	No	Indicates whether remote debugging is allowed.	false

Response elements

Element	Type	Description	Example
	object	The API response.
Code	integer	The status of the API call or a POP error code.	200
Message	string	Additional information.	success
RequestId	string	The ID of the request.	b197-40ab-9155-****
UserDefineRegionList	object
UserDefineRegionEntity	array<object>	The list of namespaces.
	object	The namespace object.
BelongRegion	string	The ID of the physical region to which the namespace belongs.	cn-shenzhen
RegionName	string	The name of the namespace.	betaappManager
Description	string	The description of the namespace.	betaappManager
DebugEnable	boolean	Indicates whether remote debugging is allowed.	false
UserId	string	The ID of the Alibaba Cloud account.	edas_**_test@aliyun-**.com
Id	integer	The unique ID.	1330
RegionId	string	The ID of the namespace. Note This ID cannot be changed after the namespace is created. The format is `Physical region ID:Logical region identifier`.	cn-shenzhen:betaappManager
MseInstanceId	string	The type of the registry. Valid values: default: the shared registry of EDAS. exclusive_mse: an MSE Nacos registry.	default:EDAS
RegistryType	string	The ID of the MSE registry instance.	mse_prepaid_public_cn-tl32n******

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "UserDefineRegionList": {
    "UserDefineRegionEntity": [
      {
        "BelongRegion": "cn-shenzhen",
        "RegionName": "betaappManager",
        "Description": "betaappManager",
        "DebugEnable": false,
        "UserId": "edas_****_test@aliyun-****.com",
        "Id": 1330,
        "RegionId": "cn-shenzhen:betaappManager",
        "MseInstanceId": "default:EDAS",
        "RegistryType": "mse_prepaid_public_cn-tl32n******"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.