tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateGrafanaInstance

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

1. API Description

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

This API is used to create a monthly subscribed TCMG instance of the Basic Edition, with auto-renewal enabled and vouchers not allowed by default.

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: CreateGrafanaInstance.
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.
InstanceName Yes String Instance name
VpcId Yes String VPC ID
SubnetIds.N Yes Array of String Array of subnet IDs
GrafanaInitPassword Yes String Initial Grafana password
EnableInternet Yes Boolean Whether to enable public network access
TagSpecification.N No Array of PrometheusTag Tag

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance name
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a TCMG instance

This example shows you how to create a TencentCloud Managed Service for Grafana (TCMG) instance.

Input Example

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

{
    "SubnetIds": [
        "subnet-123"
    ],
    "VpcId": "vpc-123",
    "InstanceName": "test",
    "GrafanaInitPassword": "test",
    "EnableInternet": true
}

Output Example

{
    "Response": {
        "InstanceId": "grafana-c1enzs01",
        "RequestId": "fpllngzieyoh54e1244ols7k2hh3gdny"
    }
}

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
FailedOperation Operation failed.
FailedOperation.AccessTagFail Failed to access the tag service.
FailedOperation.CreateInstanceLimited This account is not allowed to create instances.
FailedOperation.DbRecordCreateFailed Failed to create the database record.
FailedOperation.RegionUnavailable The region is unavailable.
FailedOperation.ZoneUnavailable The AZ is unavailable.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy