调用DescribeNamespace接口查询命名空间详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
NamespaceId String Query cn-beijing:test

命名空间ID。默认命名空间不可查询、更改或删除。

NameSpaceShortId String Query test

短版命名空间ID,不需要带上region;不超过20个字符,仅允许小写英文字母和数字。

返回数据

名称 类型 示例值 描述
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

请求ID。

Message String success

附加信息。取值说明如下:

  • 请求正常,返回success
  • 请求异常,返回具体异常错误码。
TraceId String 0a981dd515966966104121683d****

调用链ID,用于精确查询调用信息。

Data Object

命名空间信息。

NamespaceDescription String desc

命名空间描述。

NamespaceId String cn-beijing:test

命名空间ID。默认命名空间不可查询、更改或删除。

NamespaceName String name

命名空间名称。

RegionId String cn-beijing

地域。

NameSpaceShortId String test

短版命名空间ID。

EnableMicroRegistration Boolean true

是否已启用SAE内置注册中心:

  • true
  • false
ErrorCode String

错误码。取值说明如下:

  • 请求成功:不返回ErrorCode字段。
  • 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码目录。
Code String 200

接口状态或POP错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Success Boolean true

查询命名空间信息是否成功。取值说明如下:

  • true:查询成功。
  • false:查询失败。

示例

请求示例

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

正常返回示例

XML格式

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格式

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
}

错误码

访问错误中心查看更多错误码。