Release Notes
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to list all Grafana alert channels.
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: DescribeGrafanaChannels. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-hongkong, ap-jakarta, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley. |
| InstanceId | Yes | String | TCMG instance ID, such as “grafana-12345678”. |
| Offset | Yes | Integer | Offset. |
| Limit | Yes | Integer | Number of items to be queried |
| ChannelName | No | String | Alert channel name, such as “test”. |
| ChannelIds.N | No | Array of String | Alert channel ID, such as “nchannel-abcd1234”. |
| ChannelState | No | Integer | Alert channel status |
| Parameter Name | Type | Description |
|---|---|---|
| NotificationChannelSet | Array of GrafanaChannel | Array of alert channels |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGrafanaChannels
<Common request parameters>
{
"InstanceId": "grafana-12345678",
"ChannelState": 0,
"Limit": 0,
"Offset": 0,
"ChannelName": "test",
"ChannelIds": [
"nchannel-abcd1234"
]
}{
"Response": {
"NotificationChannelSet": [
{
"Receivers": [
"xx"
],
"ChannelId": "nchannel-abcd1234",
"OrganizationIds": [
"xx"
],
"UpdatedAt": "2020-09-22T00:00:00+00:00",
"ChannelName": "test",
"CreatedAt": "2020-09-22T00:00:00+00:00"
}
],
"RequestId": "xx"
}
}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 |
|---|---|
| FailedOperation | Operation failed. |
フィードバック