Queries the information of a namespace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request and response headers.

Request syntax

GET /pop/v1/paas/namespace HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
NamespaceId String Query No cn-beijing:test

The namespace ID. You cannot query, modify, or delete the default namespace.

NameSpaceShortId String Query No test

The short ID of the namespace. You do not need to specify a region ID. The value of this parameter can be up to 20 characters in length and can contain only lowercase letters and digits.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The request ID.

Message String success

The returned message. Valid values:

  • success: If the call is successful, success is returned.
  • An error code: If the call fails, an error code is returned.
TraceId String 0a981dd515966966104121683d****

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

Data Object

The information of the namespace.

NamespaceDescription String desc

The description of the namespace.

NamespaceId String cn-beijing:test

The namespace ID. You cannot query, modify, or delete the default namespace.

NamespaceName String name

The name of the namespace.

RegionId String cn-beijing

The region ID.

NameSpaceShortId String test

The short ID of the namespace.

EnableMicroRegistration Boolean true

Indicates whether the SAE built-in registry is enabled. Valid values:

  • true
  • false
ErrorCode String Null

The error code. Valid values:

  • If the call is successful, the ErrorCode parameter is not returned.
  • If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section in this topic.
Code String 200

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.
Success Boolean true

Indicates whether the information of the namespace was queried. Valid values:

  • true: The information was queried.
  • false: The information failed to be queried.

Examples

Sample requests

GET /pop/v1/paas/namespace?NamespaceId=cn-beijing:test HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeNamespaceResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a981dd515966966104121683d****</TraceId>
    <Data>
        <NamespaceDescription>desc</NamespaceDescription>
        <NamespaceId>cn-beijing:test</NamespaceId>
        <NamespaceName>name</NamespaceName>
        <RegionId>cn-beijing</RegionId>
        <NameSpaceShortId>test</NameSpaceShortId>
        <EnableMicroRegistration>true</EnableMicroRegistration>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeNamespaceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.