All Products
Search
Document Center

Serverless App Engine:UpdateNamespace

Last Updated:Sep 03, 2024

Updates the information about a namespace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
sae:UpdateNamespaceupdate
  • All Resources
    *
    none
none

Request syntax

PUT /pop/v1/paas/namespace

Request parameters

ParameterTypeRequiredDescriptionExample
NamespaceIdstringNo

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
NamespaceNamestringYes

The name of the namespace. The name cannot exceed 64 characters in length.

name
NamespaceDescriptionstringNo

The description of the namespace. The description cannot exceed 100 characters in length.

desc
NameSpaceShortIdstringNo

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

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The message returned for the operation.

success
TraceIdstring

The trace ID that is used to query the details of the request.

0a98a02315955564772843261e****
Dataobject

The information of the namespace.

NamespaceDescriptionstring

The description of the namespace.

desc
NamespaceIdstring

The ID of the namespace.

cn-beijing:test
NamespaceNamestring

The name of the namespace.

name
RegionIdstring

The region where the namespace resides.

cn-beijing
NameSpaceShortIdstring

The short ID of the namespace.

test
ErrorCodestring

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
Codestring

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
Successboolean

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 codeError codeError messageDescription
400InvalidNamespaceName.FormatThe 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.
400System.UpgradingThe system is being upgraded. Please try again later.-
400Exceed.NamespaceToo many namespaces have been created.-
400InvalidNamespaceId.FormatThe 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.
404InvalidNamespaceId.NotFoundThe specified NamespaceId does not exist.-

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

Change history

Change timeSummary of changesOperation
2023-03-10The Error code has changed. The request parameters of the API has changedView Change Details