Serverless应用引擎 DescribeNamespaceList

By | 2021年4月22日

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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
ContainCustom Boolean Query true

是否返回自定义命名空间。取值说明如下:

  • true:表示返回自定义命名空间。
  • false:表示不返回自定义命名空间。
HybridCloudExclude Boolean Query true

是否排除混合云命名空间。取值说明如下:

  • true:表示排除混合云命名空间。
  • false:表示不排除混合云命名空间。

返回数据

名称 类型 示例值 描述
Code String 200

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

  • 2XX:成功。
  • 3XX:重定向。
  • 4XX:请求错误。
  • 5XX:服务器错误。
Data Array of RegionList

命名空间列表。

AgentInstall String http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh

Agent安装命令。

Current Boolean false

废弃参数,无特殊含义。

Custom Boolean true

是否返回自定义命名空间。取值说明如下:

  • true:表示返回自定义命名空间。
  • false:表示不返回自定义命名空间。
HybridCloudEnable Boolean false

是否排除混合云命名空间。取值说明如下:

  • true:表示排除混合云命名空间。
  • false:表示不排除混合云命名空间。
NamespaceId String cn-beijing:test

命名空间ID。

NamespaceName String test

命名空间名称。

RegionId String cn-beijing

命名空间所属地域。

SecurityGroupId String sg-wz969ngg2e49q5i4****

安全组ID。

VSwitchId String vsw-2ze559r1z1bpwqxwp****

VSwitch ID。

VpcId String vpc-2ze0i263cnn311nvj****

VPC ID。

ErrorCode String error

错误码。

Message String success

调用结果的附加信息。

RequestId String 30375C38-F4ED-4135-A0AE-5C75DC7F****

请求ID。

Success Boolean true

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

  • true:表示获取成功。
  • false:表示获取失败。
TraceId String ac1a0b2215622920113732501e****

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

示例

请求示例

GET /pop/v1/sam/namespace/describeNamespaceList?RegionId=cn-beijing&ContainCustom=true

正常返回示例

XML格式

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

JSON格式

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

错误码

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

请关注公众号获取更多资料

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注

Iconic One Theme | Powered by Wordpress