All Products
Search
Document Center

Managed Service for Prometheus:UpdatePrometheusInstance

Last Updated:Nov 05, 2024

Updates the information about a Prometheus instance.

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.

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:UpdatePrometheusInstanceupdate
  • Prometheus
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmxyexli2****
ClusterIdstringYes

The ID of the Prometheus instance.

vpc-xxx
StorageDurationintegerNo

The data storage duration. Unit: days.

90
ArchiveDurationintegerNo

The number of days for which data is automatically archived after the storage expires. Valid values: 60, 90, 180, and 365. 0 indicates that the data is not archived.

90
EnableAuthTokenbooleanNo

Specifies whether to enable access token authentication.

EnableAuthFreeReadbooleanNo

Specifies whether to enable password-free read.

AuthFreeReadPolicystringNo

The IP addresses or CIDR blocks for which password-free read is enabled. Separate multiple IP addresses with line breaks.

EnableAuthFreeWritebooleanNo

Specifies whether to enable password-free write.

AuthFreeWritePolicystringNo

The IP addresses or CIDR blocks for which password-free write is enabled. Separate multiple IP addresses with line breaks.

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

RequestIdstring

The ID of the request.

6A9AEA84-7186-4D8D-B498-4585C6A2****
Datastring

The result of the operation.

success
Messagestring

The message returned.

message
Codeinteger

The returned status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "6A9AEA84-7186-4D8D-B498-4585C6A2****",
  "Data": "success",
  "Message": "message",
  "Code": 200
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-02The request parameters of the API has changedView Change Details