AddPrometheusRemoteWrite - Managed Service for Prometheus

Adds a remote write configuration item to a Prometheus instance.

Debugging

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

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:AddPrometheusRemoteWrite	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.	cc7a37ee31aea4ed1a059eff8034b\\\\ or vpc-xxxxx
RemoteWriteYaml	string	Yes	The details of the remote write configuration item. Specify the value in the YAML format.	remote_write: - name: rw1 url: "http://cn-hangzhou-intranet.arms.aliyuncs.com/prometheus/uid/xx/cn-hangzhou/api/v3/write" basic_auth: username: xxx password: xxx write_relabel_configs: - source_labels: [ instance_id ] separator: ; regex: si replacement: $1 action: keep - name: rw2 url: "http://cn-hangzhou-intranet.arms.aliyuncs.com/prometheus/uid/xx/cn-hangzhou/api/v3/write" basic_auth: username: xxx password: xxx write_relabel_configs: - source_labels: [ xx ] separator: ; regex: yyy replacement: $1 action: keep

Response parameters

Parameter	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	4C518054-852F-4023-ABC1-4AF95FF7****
Data	string	The name of the remote write configuration item. If the request fails, an error message is returned.	1
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
Message	string	The message returned.	message
Code	integer	The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.	200

Examples

Sample success responses

JSONformat

{
  "RequestId": "4C518054-852F-4023-ABC1-4AF95FF7****",
  "Data": "1",
  "Success": true,
  "Message": "message",
  "Code": 200
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

Change history

Change time

Summary of changes

Operation

2023-08-03

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400