GetMetricStore - Simple Log Service - Alibaba Cloud Documentation Center

Queries a Metricstore.

Operation description

Metricstores are used to store metric data. For more information about Metricstores, see Metricstores . For more information about metric data, see Metric data. You can call this operation to query the settings of a Metricstore. To query the metric data in a Metricstore, see Query and analysis and GetLogsV2 .

You must specify an existing Metricstore.
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.

The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.

The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see Manage a project.
You can create up to 200 Logstores or Metricstores in a project.
Metric data is automatically deleted when the retention period of the metric data ends.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /metricstores/{name} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	my-project
name	string	Yes	The name of the Metricstore.	my_metric_store

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The type of the response body.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	Indicates whether the connection is persistent. Valid values: close and keep-alive. close: The connection is non-persistent. A new TCP connection is established for each HTTP request. keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5
	object	The struct returned.
name	string	The name of the Metricstore.	my_metric_store
ttl	integer	The retention period. Unit: days.	7
shardCount	integer	The number of shards.	2
autoSplit	boolean	Indicates whether the automatic sharding feature is enabled.	true
maxSplitShard	integer	The maximum number of shards into which existing shards can be automatically split.	64
mode	string	The specification type of the Metricstore. Example: standard.	standard
metricType	string	The metric type of the Metricstore. Example: prometheus.	prometheus
createTime	long	The creation time. The value is a UNIX timestamp.	1698933894
lastModifyTime	long	The last update time. The value is a UNIX timestamp.	1712023974

Examples

Sample success responses

JSONformat

{
  "name": "my_metric_store",
  "ttl": 7,
  "shardCount": 2,
  "autoSplit": true,
  "maxSplitShard": 64,
  "mode": "standard",
  "metricType": "prometheus",
  "createTime": 1698933894,
  "lastModifyTime": 1712023974
}

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.

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

Change history

Change time	Summary of changes	Operation
2024-08-28	Add Operation	View Change Details