tencent cloud



Last updated: 2022-08-23 15:35:37

1. API Description

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

This API is used to create a pay-as-you-go Prometheus instance.

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: CreatePrometheusMultiTenantInstancePostPayMode.
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-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
InstanceName Yes String Instance name
VpcId Yes String VPC ID
SubnetId Yes String Subnet ID
DataRetentionTime Yes Integer Data retention period in days. Valid values: 15, 30, 45.
Zone Yes String AZ
TagSpecification.N No Array of PrometheusTag Instance tag
GrafanaInstanceId No String The Grafana instance to be associated

3. Output Parameters

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

4. Example

Example1 Creating a pay-as-you-go Prometheus instance

Input Example

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

    "SubnetId": "subnet-hjkasfd",
    "DataRetentionTime": "30",
    "VpcId": "vpc-thnssd",
    "InstanceName": "my-prom-gg",
    "Zone": "ap-chengdu-1",
    "GrafanaInstanceId": "grafana-xfa222"

Output Example

    "Response": {
        "InstanceId": "prom-xxxxxx",
        "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"

5. Developer Resources


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.CreateInstance Failed to create the instance.
FailedOperation.CreateInstanceLimited This account is not allowed to create instances.
FailedOperation.DbQueryFailed Failed to query the database.
FailedOperation.DbRecordCreateFailed Failed to create the database record.
FailedOperation.DbRecordDeleteFailed Failed to delete the database record.
FailedOperation.DbRecordUpdateFailed Failed to update the database record.
FailedOperation.ResourceNotFound The resource does not exist.
FailedOperation.SendRequest Failed to send the authorization request.
InternalError Internal error.
InvalidParameter Invalid parameter.
MissingParameter Missing parameter.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support