All Products
Search
Document Center

Managed Service for Prometheus:UpdateEnvServiceMonitor

Last Updated:May 09, 2024

Updates the ServiceMonitor of an environment.

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
arms:UpdateEnvServiceMonitorWrite
  • Environment
    acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
AliyunLangstringNo

The language. Valid values: zh and en. Default value: zh.

zh
EnvironmentIdstringYes

The environment ID.

env-xxxxx
NamespacestringYes

The namespace where the ServiceMonitor is located.

arms-prom
ServiceMonitorNamestringYes

The name of the ServiceMonitor.

serviceMonitor1
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request.

true
ConfigYamlstringYes

The YAML configuration string.

Refer to supplementary instructions.

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

1A474FF8-7861-4D00-81B5-5BC3DA4E****
Codeinteger

The HTTP status code. The status code 200 indicates that the request was successful.

200
Dataobject

The returned struct.

MatchedMsgstring

Indicates whether targets are matched.

Match successful.
MatchedTargetCountstring

The number of matched targets.

1
Messagestring

The returned message.

success

Examples

Sample success responses

JSONformat

{
  "RequestId": "1A474FF8-7861-4D00-81B5-5BC3DA4E****",
  "Code": 200,
  "Data": {
    "MatchedMsg": "\t\nMatch successful.\n",
    "MatchedTargetCount": "1"
  },
  "Message": "success"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history