All Products
Search
Document Center

CloudMonitor:DescribeMonitoringAgentConfig

Last Updated:Jul 26, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
cms:DescribeMonitoringAgentConfigget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
EnableActiveAlertstring

The service for which one-click alert is enabled.

redis,rds,ecs
RequestIdstring

The ID of the request.

E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D
AutoInstallboolean

Indicates whether the Cloud Monitor agent is automatically installed on existing Elastic Compute Service (ECS) instances. Valid values:

  • true
  • false
true
Successboolean

Indicates whether the operation was successful. Valid values:

  • true: successful.
  • false: failed.
true
EnableInstallAgentNewECSboolean

Indicates whether the Cloud Monitor agent is automatically installed on new ECS instances. Valid values:

  • true
  • false
true
Codestring

The status code.

Note The status code 200 indicates a success.
200
Messagestring

The error message.

The Request is not authorization.

Examples

Sample success responses

JSONformat

{
  "EnableActiveAlert": "redis,rds,ecs",
  "RequestId": "E9F4FA2A-54BE-4EF9-9D1D-1A0B1DC86B8D",
  "AutoInstall": true,
  "Success": true,
  "EnableInstallAgentNewECS": true,
  "Code": "200",
  "Message": "The Request is not authorization."
}

Error codes

HTTP status codeError codeError message
400InvalidParameterThe specified parameter is not valid.
403InvalidAuthorizationThe Request is not authorization.
500InternalErrorThe request processing has failed due to some unknown error.

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