All Products
Search
Document Center

Managed Service for Prometheus:ListPrometheusRemoteWrites

Last Updated:May 09, 2024

Queries the remote write configuration items of a Prometheus instance.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.

cc7a37ee31aea4ed1a059eff8034b\*\*\*\* or vpc-\*\*\*\*

Response parameters

ParameterTypeDescriptionExample
object

The response object.

RequestIdstring

The request ID.

9319A57D-2D9E-472A-B69B-CF3CD16D****
Dataobject []

The remote write configuration items returned.

[ { "name": "TiDBxxx", "yaml": "remote_write:\\n- basic_auth: {password: '******', username: xxx}\\n name: TiDBxxx\\n write_relabel_configs:\\n - regex: si-6e2ca86444db4e55a7c1\\n source_labels: [instance_id]\\n action: keep\\n separator: ;\\n replacement: $1\\n url: http://xxx:8080/prometheus/xxx/ddd/cn-hangzhou/api/v3/write\\n" }, { "name": "TiDBxxx1", "yaml": "remote_write:\\n- basic_auth: {password: '******', username: xxx}\\n name: TiDBxxx1\\n write_relabel_configs:\\n - regex: si-6e2ca86444db4e55a7c1\\n source_labels: [instance_id]\\n action: keep\\n separator: ;\\n replacement: $1\\n url: http://xxx:8080/prometheus/xxx/ddd/cn-hangzhou/api/v3/write\\n" } ]
ClusterIdstring

The ID of the Prometheus instance.

c589a1b8db05c4561aefbb898ca8fb1cf
RemoteWriteNamestring

The name of the remote write configuration item.

abc123
RemoteWriteYamlstring

The information about the queried remote write configuration item of the Prometheus instance. The information is displayed 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
Successboolean

Indicates whether the request was successful. Valid values: true and false.

true
Messagestring

The message returned.

message
Codeinteger

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": "9319A57D-2D9E-472A-B69B-CF3CD16D****",
  "Data": [
    {
      "ClusterId": "c589a1b8db05c4561aefbb898ca8fb1cf",
      "RemoteWriteName": "abc123",
      "RemoteWriteYaml": "remote_write:\n  - name: rw1\n    url: \"http://cn-hangzhou-intranet.arms.aliyuncs.com/prometheus/uid/xx/cn-hangzhou/api/v3/write\"\n    basic_auth:\n      username: xxx\n      password: xxx\n    write_relabel_configs:\n      - source_labels: [ instance_id ]\n        separator: ;\n        regex: si\n        replacement: $1\n        action: keep"
    }
  ],
  "Success": true,
  "Message": "message",
  "Code": 200
}

Error codes

HTTP status codeError codeError message
400IdempotentParameterMismatchThe 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 timeSummary of changesOperation
No change history