使用DescribeNamespaceList获取命名空间列表-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

调用DescribeNamespaceList接口获取命名空间列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:DescribeNamespaceList

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/namespace/describeNamespaceList HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
ContainCustom	boolean	否	是否返回自定义命名空间。取值说明如下： true：返回自定义命名空间。 false：不返回自定义命名空间。	true
HybridCloudExclude	boolean	否	是否排除混合云命名空间。取值说明如下： true：排除混合云命名空间。 false：不排除混合云命名空间。	true

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	ac1a0b2215622920113732501e****
Data	array<object>	命名空间列表。
	object	命名空间信息。
VpcId	string	VPC ID。	vpc-2ze0i263cnn311nvj****
VSwitchId	string	vSwitch ID。	vsw-2ze559r1z1bpwqxwp****
Custom	boolean	是否返回自定义命名空间。取值说明如下： true：返回自定义命名空间。 false：不返回自定义命名空间。	true
AgentInstall	string	Agent 安装命令。	http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh
NamespaceId	string	命名空间 ID。	cn-beijing:test
HybridCloudEnable	boolean	是否排除混合云命名空间。取值说明如下： true：排除混合云命名空间。 false：不排除混合云命名空间。	false
SecurityGroupId	string	安全组 ID。	sg-wz969ngg2e49q5i4****
Current	boolean	废弃参数，无特殊含义。	false
NamespaceName	string	命名空间名称。	test
RegionId	string	命名空间所属地域。	cn-beijing
NameSpaceShortId	string	短版命名空间 ID。	test
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取命名空间列表是否成功。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Data": [
    {
      "VpcId": "vpc-2ze0i263cnn311nvj****",
      "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
      "Custom": true,
      "AgentInstall": "http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh",
      "NamespaceId": "cn-beijing:test",
      "HybridCloudEnable": false,
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
      "Current": false,
      "NamespaceName": "test",
      "RegionId": "cn-beijing",
      "NameSpaceShortId": "test"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

错误码

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

变更历史

更多信息，参考变更详情。