Query Namespace Resources with DescribeNamespaceResources - SAE - Alibaba Cloud - Serverless App Engine

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

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
NamespaceId	string	No	The ID of the namespace. The format is `Region ID:Namespace name`. This parameter is retained for backward compatibility. If you specify this parameter, `NameSpaceShortId` is ignored. We recommend that you use `NameSpaceShortId` to simplify the request.	cn-shanghai:test
NameSpaceShortId	string	No	The ID of the namespace. The region ID is not included. We recommend that you use this parameter.	test

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. Valid values: If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The trace ID. You can use this ID to query the details of the call.	0a98a02315955564772843261e****
Data	object	The response data.
VpcId	string	The VPC ID.	vpc-2ze0i263cnn311nvj****
LastChangeOrderId	string	The release order ID.	afedb3c4-63f8-4a3d-aaa3-2c30363f****
BelongRegion	string	The region of the namespace.	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 release order is ready. RUNNING: The release order is running. SUCCESS: The release order was successful. FAIL: The release order failed. ABORT: The release order was aborted. WAIT_BATCH_CONFIRM: The release order is waiting for manual batch confirmation. AUTO_BATCH_WAIT: The release order is in an automatic batch-wait state. SYSTEM_FAIL: A system error occurred. WAIT_APPROVAL: The release order is pending approval. APPROVED: The release order is approved and 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 notification for the release order has expired. Valid values: true: The notification has expired. false: The notification 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	The version of the APM Java agent.
SlsConfigs	string	The configuration for collecting logs to Simple Log Service (SLS). To use SLS resources that are automatically created by SAE: `[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]`. To use custom SLS resources: `[{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]`. The configuration includes the following parameters: projectName: The project name in SLS. logDir: The log path. logType: The log type. stdout indicates the standard output of the container. Only one stdout entry is allowed. If you omit this parameter, file logs are collected. logstoreName: The Logstore name in SLS. logtailName: The Logtail name in SLS. If you omit this parameter, SAE creates a Logtail. You do not need to set this parameter if the SLS log collection configuration is unchanged for subsequent deployments. To disable log collection, set this parameter to an empty string ("").
ErrorCode	string	The error code. This parameter is returned only if the request fails. For more information, see the Error codes section of this topic. A successful request does not return the ErrorCode field. A failed request returns the ErrorCode field. For more information, see the list of error codes in this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the namespace resources were queried successfully. 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.