调用DescribeNamespaces接口查询命名空间列表。

调试

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

请求头

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

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
CurrentPage Integer Query 1

当前页码。

PageSize Integer Query 10

分页查询时设置的每页数量。取值范围[0,10000]。

返回数据

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

请求ID。

Message String success

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

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

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

Data Object

命名空间信息列表。

CurrentPage Integer 1

当前页码。

TotalSize Integer 100

命名空间总数。

PageSize Integer 10

分页查询时设置的每页数量。

Namespaces Array of Namespace

命名空间列表。

NamespaceDescription String desc

命名空间描述。

AccessKey String b34dbe3315c64f9f99b58ea447ec****

ACM专用AccessKey ID,用于操作ACM某个命名空间内的数据。更多信息,请参见阿里云AccessKey和ACM专用AccessKey的区别

SecretKey String G/w6sseK7+nb3S6HBmANDBMD****

ACM专用AccessKey Secret,用于操作ACM某个命名空间内的数据。更多信息,请参见阿里云AccessKey和ACM专用AccessKey的区别

NamespaceId String cn-beijing:test

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

AddressServerHost String addr-bj-internal.edas.aliyun.com

主机服务地址。

NamespaceName String name

命名空间名称。

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

租户ID。

RegionId String cn-beijing

地域。

NameSpaceShortId String test

短版命名空间ID。

ErrorCode String

错误码。取值说明如下:

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

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

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

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

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

示例

请求示例

GET /pop/v1/paas/namespaces?CurrentPage=1&PageSize=10 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

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>
            <AddressServerHost>addr-bj-internal.edas.aliyun.com</AddressServerHost>
            <NamespaceName>name</NamespaceName>
            <TenantId>838cad95-973f-48fe-830b-2a8546d7****</TenantId>
            <RegionId>cn-beijing</RegionId>
        </Namespaces>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeNamespacesResponse>

JSON格式

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",
      "AddressServerHost" : "addr-bj-internal.edas.aliyun.com",
      "NamespaceName" : "name",
      "TenantId" : "838cad95-973f-48fe-830b-2a8546d7****",
      "RegionId" : "cn-beijing"
    } ]
  },
  "Code" : "200",
  "Success" : true
}

错误码

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