All Products
Search
Document Center

Serverless App Engine:QueryArmsEnable

Last Updated:Dec 17, 2025

Queries whether ARMS monitoring is enabled for a specified application.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
sae:QueryArmsEnable
*Application
acs:sae:{#regionId}:{#accountId}:application/{#namespaceid}/{#appid}
    none
none

Request syntax

GET /pop/v1/arms/queryArms HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The application ID.

017f39b8-dfa4-4e16-a84b-1dcee4b1****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

01CF26C7-00A3-4AA6-BA76-7E95F2A3****
Messagestring

The additional information. Value description:

  • If the request was successful, success is returned.
  • If the request failed, an error code is returned.
success
TraceIdstring

The ID of the trace, which is used to query the details of a request.

0a98a02315955564772843261e****
Dataobject

The response data.

Enableboolean

Indicates if enabled. Valid values: true and false.

true
ErrorCodestring

The error code. Value description:

  • If the request was successful, this field is not returned.
  • For more information, see the Error codes section of this topic.
InvalidApplication.NotFound
Codestring

The status code or error code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: The request was invalid. 5xx: A server error occurred.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Enable": true
  },
  "ErrorCode": "InvalidApplication.NotFound\t",
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError message
400InvalidApplication.NotFoundThe current application does not exist.

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