UpdateNamespace - - Alibaba Cloud Documentation Center

Updates the information about a namespace.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:UpdateNamespace	update	All Resources ``	none	none

Request syntax

PUT /pop/v1/paas/namespace HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The long ID of the namespace. If you configure this parameter, the long ID take effects and the value of the NameSpaceShortId parameter is ignored. To ensure compatibility, we recommend that you specify a short namespace ID. A long namespace ID follows the `<RegionId>:<NamespaceId>` format. The `NamespaceId` variable can contain only lowercase letters and digits. Example: `cn-beijing:test`. The value of the NamespaceId variable cannot exceed 32 characters in length. For more information about RegionId, you can call the DescribeRegions operation to obtain the IDs of regions supported by SAE.	cn-beijing:test
NamespaceName	string	Yes	The name of the namespace. The name cannot exceed 64 characters in length.	name
NamespaceDescription	string	No	The description of the namespace. The description cannot exceed 100 characters in length.	desc
NameSpaceShortId	string	No	The short ID of the namespace. You do not need to specify a region ID. We recommend that you configure this parameter. The value of this parameter can be up to 20 characters in length and can contain only lowercase letters and digits.	test

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The message returned for the operation.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The information of the namespace.
NamespaceDescription	string	The description of the namespace.	desc
NamespaceId	string	The ID of the namespace.	cn-beijing:test
NamespaceName	string	The name of the namespace.	name
RegionId	string	The region where the namespace resides.	cn-beijing
NameSpaceShortId	string	The short ID of the namespace.	test
ErrorCode	string	The error code returned. Take note of the following rules: The ErrorCode parameter is not returned if the request succeeds. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.	Null
Code	string	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the information about the namespace was updated. Valid values: true: The instance was updated. false: The instance failed to be updated.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "NamespaceDescription": "desc",
    "NamespaceId": "cn-beijing:test",
    "NamespaceName": "name",
    "RegionId": "cn-beijing",
    "NameSpaceShortId": "test",
    "EnableMicroRegistration": true
  },
  "ErrorCode": "Null\n",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidNamespaceName.Format	The specified NamespaceName is invalid. The name of the namespace cannot exceed 63 characters in length.	The specified NamespaceName is invalid. The name of the namespace cannot exceed 63 characters in length.
400	System.Upgrading	The system is being upgraded. Please try again later.	-
400	Exceed.Namespace	Too many namespaces have been created.	-
400	InvalidNamespaceId.Format	The specified NamespaceId is invalid.	The specified NamespaceId is invalid. The correct format is [regionId]:[namespace]. For example, cn-beijing:test. NamespaceId cannot exceed 32 characters in length.
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.	-

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

Change history

Change time	Summary of changes	Operation
2023-03-10	The Error code has changed. The request parameters of the API has changed	View Change Details