GetMetricStore-阿里云帮助中心

Queries a Metricstore.

Operation description

A Metricstore is used to store metrics. This operation only queries the configurations of a Metricstore. To query metrics in a Metricstore, see Query and analysis and GetLogsV2.

This operation requires an existing Metricstore.
The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has access permissions for all API operations, which involves high risks. 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 permissions to manage Operation logs and Simple Log Service EPS resources. 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 want to query belong. For more information, see Manage projects.
You can create up to 200 Logstores or Metricstores in a project.
Timing metric data is deleted when the data retention period reaches the data retention period in your Settings.

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

get

*MetricStore

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

None

Request syntax

GET /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

Response elements

Element	Type	Description	Example
	object	The response struct.
name	string	The name of the Metricstore.	my_metric_store
ttl	integer	The data retention period. Unit: days.	7
shardCount	integer	The number of shards.	2
autoSplit	boolean	Specifies whether automatic sharding is enabled.	true
maxSplitShard	integer	The maximum number of shards for automatic sharding.	64
mode	string	The specification type of the Metricstore. Example: standard.	standard
metricType	string	The type of the Metricstore. Example: prometheus.	prometheus
createTime	integer	The time when the Metricstore was created. The value is a UNIX timestamp.	1698933894
lastModifyTime	integer	The time when the Metricstore was last updated. The value is a UNIX timestamp.	1712023974
hot_ttl	integer	The retention period of data in the hot tier. Unit: days.	60
infrequentAccessTTL	integer	The retention period of data in the infrequent access (IA) tier. Unit: days.	30
appendMeta	boolean	Specifies whether to record the public IP addresses and the log reception time.	false
shardingPolicy	ShardingPolicy	The hash-based write configuration.
processorId	string	The ID of the write processor associated with the Metricstore.	ingest-processor-1756802123-953901

Examples

Success response

JSON format

{
  "name": "my_metric_store",
  "ttl": 7,
  "shardCount": 2,
  "autoSplit": true,
  "maxSplitShard": 64,
  "mode": "standard",
  "metricType": "prometheus",
  "createTime": 1698933894,
  "lastModifyTime": 1712023974,
  "hot_ttl": 60,
  "infrequentAccessTTL": 30,
  "appendMeta": false,
  "shardingPolicy": {
    "shardGroup": {
      "keys": [
        "userId"
      ],
      "groupCount": 8
    },
    "shardHash": {
      "keys": [
        "instanceId"
      ],
      "maxHashCount": 2
    },
    "queryActiveTime": 1764659409,
    "enabled": true
  },
  "processorId": "ingest-processor-1756802123-953901"
}

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.