Update SAE Namespace Details via UpdateNamespace API - SAE - Alibaba Cloud - Serverless App Engine

Update the information about a namespace.

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

sae:UpdateNamespace

update

*All Resource

*

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
EnableMicroRegistration	boolean	No	Indicates whether to enable SAE built-in registry: true false If you set this parameter to true, a shared registry is created for the namespace. The registry cannot be disabled after it is created.	true

Response elements

Element	Type	Description	Example
	object	The returned data.
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 about a 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
EnableMicroRegistration	boolean	Indicates whether to enable SAE built-in registry: true false	true
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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.