PutMonitoringConfig

Updated at:

Sets the global configurations of the CloudMonitor agent.

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

cms:PutMonitoringConfig

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AutoInstall

boolean

No

This parameter is not used.

true

EnableInstallAgentNewECS

boolean

No

Specifies whether to automatically install the CloudMonitor agent on newly purchased ECS instances. Valid values:

  • true: Automatically installs the CloudMonitor agent on newly purchased ECS instances.

  • false: Does not automatically install the CloudMonitor agent on newly purchased ECS instances. Default value: true.

true

DryRun

boolean

No

Specifies whether to perform a dry run on the request. Valid values:

  • true: sends a check request without deleting the endpoint IPAM pool. The check items include whether required parameters are specified, the request format, and service limits. If the request fails the check, an error is returned. If the request passes the check, the DryRunOperation error code is returned.

  • false (default value): sends a normal request and directly deletes the endpoint IPAM pool if the request passes the check. Default value: false.

false

Response elements

Element

Type

Description

Example

object

Code

integer

The status code.

Note

200 indicates success.

200

Message

string

The error message.

Specified parameter EnableInstallAgentNewECS is not valid.

RequestId

string

The request ID.

109C8095-6FAD-4DBB-B013-6ED18CE4C0B1

Success

boolean

Indicates whether the operation is successful. Valid values:

  • true: The operation succeeded.

  • false: The operation failed.

true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Specified parameter EnableInstallAgentNewECS is not valid.",
  "RequestId": "109C8095-6FAD-4DBB-B013-6ED18CE4C0B1",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter The specified parameter is not valid.
412 DryRunOperation %s. dryRun Pre-Verification Results
500 InternalError The request processing has failed due to some unknown error.
403 InvalidAuthorization The Request is not authorization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.