CreateEnvServiceMonitor - Managed Service for Prometheus

Creates a ServiceMonitor for an environment.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
arms:CreateEnvServiceMonitor	create	Environment acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
AliyunLang	string	No	The language. Valid values: zh (default): Chinese en: English	zh
EnvironmentId	string	Yes	The ID of the environment instance.	env-xxxxxx
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. The system checks whether the format is valid and whether targets are matched.	true
ConfigYaml	string	Yes	The YAML configuration file of the ServiceMonitor.	Refer to supplementary instructions.

Sample ConfigYAML:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: arms-admin1
  namespace: arms-prom
  annotations:
    arms.prometheus.io/discovery: 'true'
spec:
  endpoints:
  - interval: 30s
    port: operator
    path: /metrics
  - interval: 10s
    port: operator1
    path: /metrics
  namespaceSelector:
    any: true
  selector:
    matchLabels:
     app: arms-prometheus-ack-arms-prometheus

You must specify arms.prometheus.io/discovery and set the value to true to enable the ServiceMonitor.

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	78901766-3806-4E96-8E47-CFEF59E4****
Code	integer	The HTTP status code. The status code 200 indicates that the request was successful.	200
Data	object	The returned struct.
MatchedMsg	string	Indicates whether targets are matched.	Match successful.
Namespace	string	The namespace.	arms-prom
ServiceMonitorName	string	The name of the created ServiceMonitor.	arms-admin1
MatchedTargetCount	integer	The number of matched targets.	1
Message	string	The returned message.	message

Examples

Sample success responses

JSONformat

{
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Code": 200,
  "Data": {
    "MatchedMsg": "Match successful.\n",
    "Namespace": "arms-prom",
    "ServiceMonitorName": "arms-admin1",
    "MatchedTargetCount": 1
  },
  "Message": "message"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history