文档

DescribeNamespaces - 查询命名空间列表

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeNamespacesget
  • 全部资源
    *

请求语法

GET /pop/v1/paas/namespaces

请求参数

名称类型必填描述示例值
CurrentPageinteger

当前页码。

1
PageSizeinteger

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

10

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

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

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

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

0a981dd515966966104121683d****
Dataobject

命名空间信息列表。

CurrentPageinteger

当前页码。

1
TotalSizeinteger

命名空间总数。

100
PageSizeinteger

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

10
Namespacesarray<object>

命名空间列表。

object

命名空间信息。

NamespaceDescriptionstring

命名空间描述。

desc
AccessKeystring

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

b34dbe3315c64f9f99b58ea447ec****
SecretKeystring

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

G/w6sseK7+nb3S6HBmANDBMD****
NamespaceIdstring

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

cn-beijing:test
AddressServerHoststring

主机服务地址。

addr-bj-internal.edas.aliyun.com
NamespaceNamestring

命名空间名称。

name
TenantIdstring

租户 ID。

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

地域。

cn-beijing
NameSpaceShortIdstring

短版命名空间 ID。

test
ErrorCodestring

错误码。取值说明如下:

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

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

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

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

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

示例

正常返回示例

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",
        "NameSpaceShortId": "test"
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-10-13OpenAPI 返回结构发生变更查看变更详情