All Products
Search
Document Center

Application Real-Time Monitoring Service:QueryAppMetadata

Last Updated:May 29, 2026

Queries application metadata by ID and type.

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

arms:QueryAppMetadata

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

MetaIds

string

Yes

The metadata IDs. Use a comma (,) to separate multiple IDs.

You can obtain the exception ID on the exception analysis page of the target application in the ARMS console.

4c9dd447,3c76c565

MetaType

string

Yes

The type of the metadata. Valid values:

  • sql: Retrieves the SQL statement by sqlId.

  • exception: Retrieves the exception stack by exceptionId.

Valid values:

  • exception :

    exception

  • sql :

    sql

sql

Pid

string

Yes

The application ID. To obtain the ID, call the ListTraceApps operation.

ggxw4lnjuz@54364d85b******

RegionId

string

Yes

The region ID.

cn-hangzhou

StartTimeMs

integer

No

EndTimeMs

integer

No

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The request ID.

51877BAC-330C-5845-BDFD-C7859AD33FB7

Data

object

The returned object.

{'408d5533': 'SELECT * FROM user_base_info'}

Code

integer

The API call status.

  • 2xx: The request was successful.

  • 3xx: The request was redirected.

  • 4xx: A client-side error occurred.

  • 5xx: A server-side error occurred.

200

HttpStatusCode

integer

The HTTP status code.

200

Success

boolean

Indicates whether the query was successful.

  • true: The query was successful.

  • false: The query failed.

True

Examples

Success response

JSON format

{
  "RequestId": "51877BAC-330C-5845-BDFD-C7859AD33FB7",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": 200,
  "HttpStatusCode": 200,
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.