Queries the details of namespaces.

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 uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

GET /pop/v1/paas/namespaces HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
CurrentPage Integer Query Yes 1

The number of the page to return.

PageSize Integer Query Yes 10

The number of entries to return on each page. Valid values: 0 to 10000.

Response parameters

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

The ID of the request.

Message String success

The returned message.

  • success is returned when the request succeeds.
  • An error message is returned when the request fails.
TraceId String 0a981dd515966966104121683d****

The ID of the trace. It can be used to query the details of a request.

Data Object

The information of namespaces.

CurrentPage Integer 1

The page number of the returned page.

TotalSize Integer 100

The total number of namespaces.

PageSize Integer 10

The number of entries returned on each page.

Namespaces Array of Namespace

The list of namespaces.

NamespaceDescription String desc

The description of the namespace.

AccessKey String b34dbe3315c64f9f99b58ea447ec****

The ACM-specific AccessKey ID. It can be used to manage data in an Application Configuration Management (ACM) namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.

SecretKey String G/w6sseK7+nb3S6HBmANDBMD****

The ACM-specific AccessKey secret. It can be used to manage data in an ACM namespace. For more information, see Differences between Alibaba Cloud AccessKey and ACM-specific AccessKey.

NamespaceId String cn-beijing:test

The ID of the namespace. The information of the default namespace cannot be queried or modified. The default namespace cannot be deleted.

NamespaceName String name

The name of the namespace.

TenantId String 838cad95-973f-48fe-830b-2a8546d7****

The ID of the tenant.

RegionId String cn-beijing

The ID of the region.

ErrorCode String This parameter is left empty.

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code String 200

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request failed.
  • 5xx: indicates that a server error occurred.
Success Boolean true

Indicates whether the details of namespaces were queried successfully. Valid values:

  • true: indicates that the query was successful.
  • false: indicates that the query failed.

Examples

Sample requests

GET /pop/v1/paas/namespaces?CurrentPage=1&PageSize=10 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

<DescribeNamespacesResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a981dd515966966104121683d****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <TotalSize>100</TotalSize>
        <PageSize>10</PageSize>
        <Namespaces>
            <NamespaceDescription>desc</NamespaceDescription>
            <AccessKey>b34dbe3315c64f9f99b58ea447ec****</AccessKey>
            <SecretKey>G/w6sseK7+nb3S6HBmANDBMD****</SecretKey>
            <NamespaceId>cn-beijing:test</NamespaceId>
            <NamespaceName>name</NamespaceName>
            <TenantId>838cad95-973f-48fe-830b-2a8546d7****</TenantId>
            <RegionId>cn-beijing</RegionId>
        </Namespaces>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeNamespacesResponse>

JSON format

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

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a981dd515966966104121683d****",
  "Data" : {
    "CurrentPage" : 1,
    "TotalSize" : 100,
    "PageSize" : 10,
    "Namespaces" : [ {
      "NamespaceDescription" : "desc",
      "AccessKey" : "b34dbe3315c64f9f99b58ea447ec****",
      "SecretKey" : "G/w6sseK7+nb3S6HBmANDBMD****",
      "NamespaceId" : "cn-beijing:test",
      "NamespaceName" : "name",
      "TenantId" : "838cad95-973f-48fe-830b-2a8546d7****",
      "RegionId" : "cn-beijing"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.