All Products
Search

This Product

    Simple Log Service:CreateMetricStore

    Document Center

    Simple Log Service:CreateMetricStore

    Last Updated:Jan 15, 2026

    Creates a Metricstore to store metrics.

    Operation description

    A Metricstore is used to store metrics.

    • The Host in the request syntax consists of a project name and a Simple Log Service Endpoint. The project name must be specified in the Host.

    • An AccessKey pair is required. For more information, see AccessKey pair.

    An AccessKey pair for an Alibaba Cloud account has full permissions on all API operations. This poses a high security risk. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform operations and maintenance (O&M). If you use a RAM user, you must grant the RAM user the permissions to manage Simple Log Service resources. For more information, see Create and authorize a RAM user.

    • The name and region of the project are required. For more information, see Manage a project.

    • A project can contain a maximum of 200 Logstores or Metricstores.

    • Metrics are deleted after the specified data retention period ends.

    • A Logstore and a Metricstore in the same project cannot have the same name.

    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:CreateMetricStore

    create

    *MetricStore

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

    		 None None

    Request syntax

    POST /metricstores HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    project

    string

    Yes

    The name of the project.

    my-project
    body

    object

    No

    The request body.

    name

    string

    Yes

    The name of the Metricstore to create.

    my_metric_store
    ttl

    integer

    Yes

    The data retention period of the Metricstore. Unit: days.

    7
    shardCount

    integer

    Yes

    The number of shards for the Metricstore.

    2
    autoSplit

    boolean

    No

    Specifies whether to enable automatic shard splitting.

    true
    maxSplitShard

    integer

    No

    The maximum number of shards into which a shard can be split. This parameter is valid only if autoSplit is set to true.

    64
    mode

    string

    No

    The type of the Metricstore. Only standard is supported. The default value is standard.

    standard
    metricType

    string

    No

    The type of the Metricstore. Only prometheus is supported. The default value is prometheus.

    prometheus
    hot_ttl

    integer

    No

    The period for which data is stored in the hot tier. Unit: days. The value must be at least 7 and cannot be greater than the value of ttl. If you set this parameter to -1, all data is stored in the hot tier for the duration specified by ttl.

    When the hot storage period ends, the data is moved to the IA storage class. For more information, see Tiered Storage of Hot and Cold Data.

    60
    infrequentAccessTTL

    integer

    No

    The retention period of data in the IA storage class. Unit: days. The minimum value is 30. After this period, data is moved to Archive Storage.

    30
    appendMeta

    boolean

    No

    Specifies whether to record the public IP address of the client. The default value is false.

    • true: Records the public IP address.

    • false: Does not record the public IP address.

    false
    shardingPolicy ShardingPolicy

    No

    The write hashing configuration.

    Response elements

    Element

    Type

    Description

    Example

    None defined.

    Examples

    Success response

    JSON format

    {}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MetricStoreAlreadyExist The specified metricstore xxx already exists. The specified metricstore xxx already exists.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.