UpdateMetricStore

Updated at:

Updates the configurations of an existing Metricstore that is used to store time series data.

Operation description

Metricstores are used to store time series data.

  • You must specify an existing Metricstore when you call this operation.

  • The Host parameter in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host parameter.

  • An AccessKey pair is created and obtained. For more information, see AccessKey pairs.

The AccessKey pair of an Alibaba Cloud account has access permissions for all API operations. Using these credentials to perform API operations is highly risky. Create and use a Resource Access Management (RAM) user to call API operations or perform routine O&M. The Resource Access Management (RAM) user must have access permissions to manage the Simple Log Service EPS resource and Operation logs. For more information, see Create a Resource Access Management (RAM) user and authorization.

  • You have identified the name and region of the project to which the logs you query belong. For more information, see Manage a project.

  • You can create up to 200 Logstores or Metricstores in a project.

  • When the data retention period of timing data reaches the data retention period specified in your Settings, the data is deleted.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

log:UpdateMetricStore

update

*MetricStore

acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}

None None

Request syntax

PUT /metricstores/{name} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

name

string

Yes

The name of the Metricstore.

my_metric_store

Request parameters

Parameter

Type

Required

Description

Example

project

string

Yes

The name of the project.

my-project

body

object

No

The request body.

ttl

integer

No

The retention period of data. Unit: days.

7

autoSplit

boolean

No

Specifies whether to enable automatic sharding.

true

maxSplitShard

integer

No

The maximum number of shards for automatic sharding. This parameter takes effect only when autoSplit is set to true.

64

mode

string

No

The type of the Metricstore.

standard

hot_ttl

integer

No

Data retention period of data in the hot tier of the Logstore. Unit: days. Valid values: 7 to 3000. The minimum retention period is 7 days. When data retention period of data in the hot tier expires, the data is moved to the infrequent access (IA) tier. For more information, see Intelligent tiering.

60

infrequentAccessTTL

integer

No

The retention period of data in the infrequent access (IA) tier. Unit: days. No minimum retention period is required, but data must be retained for at least 30 days before it is moved to the archive tier.

30

appendMeta

boolean

No

Specifies whether to record the public IP addresses. Default value: false.

  • true: Records the public IP addresses.

  • false: Does not record the public IP addresses.

false

shardingPolicy ShardingPolicy

No

The hash-based write configuration.

Response elements

Element

Type

Description

Example

None defined.

Examples

Success response

JSON format

{}

Error codes

HTTP status code

Error code

Error message

Description

404 MetricStoreNotExist The specified metricstore xxx does not exist. The specified metricstore xxx does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.