Queries a list of namespaces.
Debugging
Request headers
This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request and response headers.
Request syntax
GET /pop/v1/sam/namespace/describeNamespaceList HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
ContainCustom | Boolean | Query | No | true | Specifies whether to return custom namespaces. Valid values:
|
HybridCloudExclude | Boolean | Query | No | true | Specifies whether to exclude hybrid cloud namespaces from the result. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 30375C38-F4ED-4135-A0AE-5C75DC7F**** | The request ID. |
Message | String | success | The returned message. Valid values:
|
TraceId | String | ac1a0b2215622920113732501e**** | The trace ID that is used to query the details of the request. |
Data | Array of RegionList | The queried namespaces. |
|
VpcId | String | vpc-2ze0i263cnn311nvj**** | The VPC ID. |
VSwitchId | String | vsw-2ze559r1z1bpwqxwp**** | The vSwitch ID. |
Custom | Boolean | true | Indicates whether custom namespaces are returned. Valid values:
|
AgentInstall | String | http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh | The command that was run to install the agent. |
NamespaceId | String | cn-beijing:test | The namespace ID. |
HybridCloudEnable | Boolean | false | Specifies whether hybrid cloud namespaces are excluded. Valid values:
|
SecurityGroupId | String | sg-wz969ngg2e49q5i4**** | The ID of the security group. |
Current | Boolean | false | This parameter is no longer valid. |
NamespaceName | String | test | The name of the namespace. |
RegionId | String | cn-beijing | The region to which the namespace belongs. |
NameSpaceShortId | String | test | The short ID of the namespace. |
ErrorCode | String | Empty | The error code. Valid values:
|
Code | String | 200 | The HTTP status code. Valid values:
|
Success | Boolean | true | Indicates whether the list of namespaces was queried. Valid values:
|
Examples
Sample requests
GET /pop/v1/sam/namespace/describeNamespaceList?ContainCustom=true&HybridCloudExclude=true HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeNamespaceListResponse>
<RequestId>30375C38-F4ED-4135-A0AE-5C75DC7F****</RequestId>
<Message>success</Message>
<TraceId>ac1a0b2215622920113732501e****</TraceId>
<Data>
<VpcId>vpc-2ze0i263cnn311nvj****</VpcId>
<VSwitchId>vsw-2ze559r1z1bpwqxwp****</VSwitchId>
<Custom>true</Custom>
<AgentInstall>http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh</AgentInstall>
<NamespaceId>cn-beijing:test</NamespaceId>
<HybridCloudEnable>false</HybridCloudEnable>
<SecurityGroupId>sg-wz969ngg2e49q5i4****</SecurityGroupId>
<Current>false</Current>
<NamespaceName>test</NamespaceName>
<RegionId>cn-beijing</RegionId>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeNamespaceListResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/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"
} ],
"Code" : "200",
"Success" : true
}
Error codes
For a list of error codes, see Service error codes.