All Products
Search

This Product

    Serverless App Engine:DescribeNamespaceResources

    Document Center

    Serverless App Engine:DescribeNamespaceResources

    Last Updated:Jan 14, 2026

    Queries the resources in a namespace.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    sae:DescribeNamespaceResources

    get

    *All Resource

    *

    		 None None

    Request syntax

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    NamespaceId

    string

    No

    The long-format namespace ID. This parameter is retained for compatibility. If you set this parameter, it takes precedence over NameSpaceShortId. Use the short-format namespace ID to simplify the request.

    cn-shanghai:test
    NameSpaceShortId

    string

    No

    The short-format namespace ID. You do not need to include the region ID. This parameter is recommended.

    test

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

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

    string

    Additional information. Valid values:

    • If the request is successful, success is returned.

    • If the request fails, a specific error code is returned.

    success
    TraceId

    string

    The trace ID of the call. It is used to query the details of a call.

    0a98a02315955564772843261e****
    Data

    object

    The returned results.

    VpcId

    string

    The VPC ID.

    vpc-2ze0i263cnn311nvj****
    LastChangeOrderId

    string

    The release order ID.

    afedb3c4-63f8-4a3d-aaa3-2c30363f****
    BelongRegion

    string

    The region where the namespace resides.

    cn-shanghai
    NamespaceId

    string

    The namespace ID.

    cn-shangha:test
    SecurityGroupId

    string

    The security group ID.

    sg-wz969ngg2e49q5i4****
    UserId

    string

    The user ID.

    test@aliyun.com
    NamespaceName

    string

    The namespace name.

    test
    LastChangeOrderStatus

    string

    The status of the last release order. Valid values:

    • READY: The last release order is ready.

    • RUNNING: The last release order is running.

    • SUCCESS: The last release order was successful.

    • FAIL: The last release order failed.

    • ABORT: The last release order was aborted.

    • WAIT_BATCH_CONFIRM: The last release order is waiting for manual batch confirmation.

    • AUTO_BATCH_WAIT: The last release order is in the automatic batch waiting state.

    • SYSTEM_FAIL: A system fault occurred.

    • WAIT_APPROVAL: The last release order is pending approval.

    • APPROVED: The last release order is approved and is pending execution.

    SUCCESS
    VpcName

    string

    The VPC name.

    test
    VSwitchId

    string

    The vSwitch ID.

    vsw-2ze559r1z1bpwqxwp****
    Description

    string

    The description of the namespace.

    decs
    LastChangeOrderRunning

    boolean

    Indicates whether a release order is running in the namespace. Valid values:

    • true: A release order is running.

    • false: No release order is running.

    true
    AppCount

    integer

    The number of applications.

    1
    VSwitchName

    string

    The vSwitch name.

    test
    NotificationExpired

    boolean

    Indicates whether the release order notification has expired. Valid values:

    • true: The release order has expired.

    • false: The release order has not expired.

    true
    TenantId

    string

    The tenant ID of the SAE namespace.

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

    string

    The ID of the jump server application.

    5ec46468-6b26-4a3c-9f7c-bf88761a****
    JumpServerIp

    string

    The IP address of the jump server.

    120.78.XXX.XX
    NameSpaceShortId

    string

    The short-format namespace ID.

    test
    ApmJavaAgentVersion

    string

    SlsConfigs

    string

    ErrorCode

    string

    The error code. Valid values:

    • If the request is successful, the ErrorCode field is not returned.

    • If the request fails, the ErrorCode field is returned. For more information, see the Error codes section in this topic.

    空
    Code

    string

    The interface status or POP error code. Valid values:

    • 2xx: success.

    • 3xx: redirection.

    • 4xx: request error.

    • 5xx: server error.

    200
    Success

    boolean

    Indicates whether the namespace resource information was successfully queried. Valid values:

    • true: The query was successful.

    • false: The query failed.

    true

    Examples

    Success response

    JSON format

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

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter.Obviously The specified parameter is invalid {%s}.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.