All Products
Search
Document Center

Application Real-Time Monitoring Service:QueryAppMetadata

Last Updated:Nov 05, 2024

Queries the encoding mapping content based on the metadata IDs and metadata type.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:QueryAppMetadataget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MetaIdsstringYes

The metadata IDs. Separate multiple IDs with commas (,).

You can obtain the exception ID on the Exception Analysis page of your application in the ARMS console.

4c9dd447,3c76c565
MetaTypestringYes

The metadata type. Valid values:

  • sql: obtains an SQL statement based on sqlId.
  • exception: obtains the exception stack based on exceptionId.
sql
PidstringYes

The process identifier (PID) of the application. You can obtain the PID of an application by calling the ListTraceApps operation.

ggxw4lnjuz@54364d85b97dc56
RegionIdstringYes

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

51877BAC-330C-5845-BDFD-C7859AD33FB7
Dataobject

The returned struct.

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

The HTTP status code returned for the request. Valid values:

  • 2XX: The request is successful.
  • 3XX: A redirection message is returned.
  • 4XX: The request is invalid.
  • 5XX: A server error occurs.
200
HttpStatusCodeinteger

The HTTP status code returned.

200
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
True

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-21The internal configuration of the API is changed, but the call is not affectedView Change Details