Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the attributes of basic metrics.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeBaseMetrics. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
Namespace | Yes | String | Service namespace. Tencent Cloud services have different namespaces. For more information on service namespaces, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the namespace of CVM |
MetricName | No | String | Metric name. Tencent Cloud services have different metric names. For more information on metric names, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the metric names of CVM |
Dimensions.N | No | Array of String | Filter by dimension. This parameter is optional. |
Parameter Name | Type | Description |
---|---|---|
MetricSet | Array of MetricSet | Listed of queried metric descriptions |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the types of basic monitoring metrics under the corresponding namespace.
https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CVM
&MetricName=AccOuttraffic
&<Common request parameters>
{
"Response": {
"RequestId": "15e8eb48-e445-48b5-97ca-985908e207bb",
"MetricSet": [
{
"Namespace": "QCE/CVM",
"MetricName": "AccOuttraffic",
"MetricCName": "Public network outbound traffic",
"MetricEName": "the out traffic",
"Unit": "MB",
"UnitCname": "",
"Period": [
10,
60,
300,
3600,
86400
],
"Periods": [
{
"Period": "10",
"StatType": [
"sum"
]
},
{
"Period": "60",
"StatType": [
"sum"
]
},
{
"Period": "300",
"StatType": [
"sum"
]
},
{
"Period": "3600",
"StatType": [
"sum"
]
},
{
"Period": "86400",
"StatType": [
"sum"
]
}
],
"Dimensions": [
{
"Dimensions": [
"InstanceId"
]
}
],
"Meaning": {
"En": "Average outbound traffic per second of public ENI",
"Zh": ""
}
}
]
}
}
This example shows you how to query the types of basic monitoring metrics under the corresponding namespace.
https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CDB
&MetricName=BytesReceived
&<Common request parameters>
{
"Response": {
"RequestId": "2102703c-a1bb-4f71-9eb8-58cdfb544590",
"MetricSet": [
{
"Namespace": "QCE/CDB",
"MetricName": "BytesReceived",
"MetricCName": "",
"MetricEName": "",
"Unit": "Bps",
"UnitCname": "",
"Period": [
60,
300,
3600,
86400
],
"Periods": [
{
"Period": "60",
"StatType": [
"max"
]
},
{
"Period": "300",
"StatType": [
"max"
]
},
{
"Period": "3600",
"StatType": [
"max"
]
},
{
"Period": "86400",
"StatType": [
"max"
]
}
],
"Dimensions": [
{
"Dimensions": [
"InstanceId",
"InstanceType"
]
}
],
"Meaning": {
"En": "Amount of accepted data",
"Zh": ""
}
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
UnsupportedOperation | Unsupported operation. |
Was this page helpful?