tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeGrafanaInstances

Last updated: 2023-08-11 16:09:18

1. API Description

Domain name for API request: monitor.tencentcloudapi.com.

This API is used to list all Grafana instances under a user account.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeGrafanaInstances.
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.
Offset Yes Integer Offset for query
Limit Yes Integer Number of items to be queried
InstanceIds.N No Array of String Array of TCMG instance IDs
InstanceName No String TCMG instance name, which can be fuzzily matched by prefix.
InstanceStatus.N No Array of Integer Query status
TagFilters.N No Array of PrometheusTag Array of tag filters

3. Output Parameters

Parameter Name Type Description
InstanceSet Array of GrafanaInstanceInfo This parameter has been disused. Use Instances instead.
TotalCount Integer Number of eligible instances
Instances Array of GrafanaInstanceInfo List of instances
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Listing TCMG instances

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGrafanaInstances
<Common request parameters>

{
    "Limit": 20,
    "Offset": 0,
    "TagFilters": [
        {
            "Key": "tagKeyTest",
            "Value": "tagValueTest"
        }
    ],
    "InstanceStatus": [
        2
    ],
    "InstanceName": "test",
    "InstanceIds": [
        "grafana-abcdefgh"
    ]
}

Output Example

{
    "Response": {
        "InstanceSet": [
            {
                "InstanceStatus": 0,
                "VpcId": "xx",
                "RootUrl": "xx",
                "Version": "xx",
                "Zone": "xx",
                "TagSpecification": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "InstanceId": "xx",
                "SubnetIds": [
                    "xx"
                ],
                "RegionId": 0,
                "InstanceChargeType": 0,
                "InternalUrl": "xx",
                "VpcName": "Test",
                "EnableSSOCamCheck": true,
                "SubnetName": "xx",
                "InternetUrl": "xx",
                "EnableSSO": true,
                "InstanceName": "xx",
                "Region": "xx",
                "CreatedAt": "2020-09-22 00:00:00"
            }
        ],
        "TotalCount": 1,
        "RequestId": "xx",
        "Instances": [
            {
                "InstanceStatus": 0,
                "VpcId": "xx",
                "RootUrl": "xx",
                "Version": "xx",
                "Zone": "xx",
                "TagSpecification": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "InstanceId": "xx",
                "SubnetIds": [
                    "xx"
                ],
                "RegionId": 0,
                "InstanceChargeType": 0,
                "InternalUrl": "xx",
                "VpcName": "Test",
                "EnableSSOCamCheck": true,
                "SubnetName": "xx",
                "InternetUrl": "xx",
                "EnableSSO": true,
                "InstanceName": "xx",
                "Region": "xx",
                "CreatedAt": "2020-09-22 00:00:00"
            }
        ]
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.AccessCAMFail Access authentication failed.
FailedOperation Operation failed.
FailedOperation.AccessTagFail Failed to access the tag service.
FailedOperation.DbQueryFailed Failed to query the database.
FailedOperation.InternalError Internal service error.
FailedOperation.SendRequest Failed to send the authorization request.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy