Queries the information about the resources in a namespace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
NamespaceId String Query No cn-shanghai:test

The ID of the namespace.

Response parameters

Parameter Type Example Description
RequestId String 91F93257-7A4A-4BD3-9A7E-2F6EAE6D****

The ID of the request.

Message String success

The returned message.

  • success is returned when the request succeeds.
  • An error code is returned when the request fails.
TraceId String 0a98a02315955564772843261e****

The ID of the trace. It can be used to query the details of a request.

Data Object

The returned data.

VpcId String vpc-2ze0i263cnn311nvj****

The ID of the virtual private cloud (VPC).

LastChangeOrderId String afedb3c4-63f8-4a3d-aaa3-2c30363f****

The ID of the change order.

BelongRegion String cn-shanghai

The region to which the namespace belongs.

NamespaceId String cn-shangha:test

The ID of the namespace.

SecurityGroupId String sg-wz969ngg2e49q5i4****

The ID of the security group.

UserId String test@aliyun.com

The ID of the user.

NamespaceName String test

The name of the namespace.

LastChangeOrderStatus String SUCCESS

The status of the latest change order. Valid values:

  • READY: The change order is ready.
  • RUNNING: The change order is being executed.
  • SUCCESS: The change order was executed.
  • FAIL: The change order could not be executed.
  • ABORT: The change order was terminated.
  • WAIT_BATCH_CONFIRM: The change order is pending execution. You must manually confirm the release batch.
  • AUTO_BATCH_WAIT: The change order is pending execution. SAE will automatically confirm the release batch.
  • SYSTEM_FAIL: A system exception occurred.
  • WAIT_APPROVAL: The change order is pending approval.
  • APPROVED: The change order is approved and is pending execution.
VpcName String test

The name of the VPC.

VSwitchId String vsw-2ze559r1z1bpwqxwp****

The ID of the vSwitch.

Description String decs

The description of the namespace.

LastChangeOrderRunning Boolean true

Indicates whether a change order is being executed in the namespace. Valid values:

  • true: indicates that a change order is being executed in the namespace.
  • false: indicates that no change orders are being executed in the namespace.
AppCount Long 1

The number of applications.

VSwitchName String test

The name of the vSwitch.

NotificationExpired Boolean true

Indicates whether the notification of a change order is expired. Valid values:

  • true: indicates that the notification is expired.
  • false: indicates that the notification is not expired.
TenantId String 838cad95-973f-48fe-830b-2a8546d7****

The ID of the tenant in the SAE namespace.

JumpServerAppId String 5ec46468-6b26-4a3c-9f7c-bf88761a****

The ID of the jump server application.

JumpServerIp String 120.78.XXX.XX

The IP address of the jump server.

ErrorCode String This parameter is left empty.

The error code.

  • The ErrorCode parameter is not returned when the request succeeds.
  • The ErrorCode parameter is returned when the request fails. For more information, see Error codes in this topic.
Code String 200

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request failed.
  • 5xx: indicates that a server error occurred.
Success Boolean true

Indicates whether the information about resources in the namespace was queried successfully. Valid values:

  • true: indicates that the query was successful.
  • false: indicates that the query failed.

Examples

Sample requests

GET /pop/v1/sam/namespace/describeNamespaceResources?NamespaceId=cn-shanghai:test 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

<DescribeNamespaceResourcesResponse>
    <RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <VpcId>vpc-2ze0i263cnn311nvj****</VpcId>
        <LastChangeOrderId>afedb3c4-63f8-4a3d-aaa3-2c30363f****</LastChangeOrderId>
        <BelongRegion>cn-shanghai</BelongRegion>
        <NamespaceId>cn-shangha:test</NamespaceId>
        <SecurityGroupId>sg-wz969ngg2e49q5i4****</SecurityGroupId>
        <UserId>test@aliyun.com</UserId>
        <NamespaceName>test</NamespaceName>
        <LastChangeOrderStatus>SUCCESS</LastChangeOrderStatus>
        <VpcName>test</VpcName>
        <VSwitchId>vsw-2ze559r1z1bpwqxwp****</VSwitchId>
        <Description>decs</Description>
        <LastChangeOrderRunning>true</LastChangeOrderRunning>
        <AppCount>1</AppCount>
        <VSwitchName>test</VSwitchName>
        <NotificationExpired>true</NotificationExpired>
        <TenantId>838cad95-973f-48fe-830b-2a8546d7****</TenantId>
        <JumpServerAppId>5ec46468-6b26-4a3c-9f7c-bf88761a****</JumpServerAppId>
        <JumpServerIp>120.78.XXX.XX</JumpServerIp>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeNamespaceResourcesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message" : "success",
  "TraceId" : "0a98a02315955564772843261e****",
  "Data" : {
    "VpcId" : "vpc-2ze0i263cnn311nvj****",
    "LastChangeOrderId" : "afedb3c4-63f8-4a3d-aaa3-2c30363f****",
    "BelongRegion" : "cn-shanghai",
    "NamespaceId" : "cn-shangha:test",
    "SecurityGroupId" : "sg-wz969ngg2e49q5i4****",
    "UserId" : "test@aliyun.com",
    "NamespaceName" : "test",
    "LastChangeOrderStatus" : "SUCCESS",
    "VpcName" : "test",
    "VSwitchId" : "vsw-2ze559r1z1bpwqxwp****",
    "Description" : "decs",
    "LastChangeOrderRunning" : true,
    "AppCount" : 1,
    "VSwitchName" : "test",
    "NotificationExpired" : true,
    "TenantId" : "838cad95-973f-48fe-830b-2a8546d7****",
    "JumpServerAppId" : "5ec46468-6b26-4a3c-9f7c-bf88761a****",
    "JumpServerIp" : "120.78.XXX.XX"
  },
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter.Obviously The specified parameter is invalid {%s}. The error message returned because the value of the %s parameter is invalid.

For a list of error codes, visit the API Error Center.