tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Observability Platform
    Documentation
    Download PDF

    DescribePrometheusInstanceDetail

    Last updated: 2023-03-21 10:17:14
    Download PDF

    1. API Description

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

    This API is used to get the details of a TMP 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: DescribePrometheusInstanceDetail.
    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.
    InstanceId Yes String Instance ID

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID
    InstanceName String Instance name
    VpcId String VPC ID
    SubnetId String Subnet ID
    InstanceStatus Integer Instance status. Valid values:

    1: Creating
    2: Running
    3: Abnormal
    4: Rebooting
    5: Terminating
    6: Service suspended
    8: Suspending service for overdue payment
    9: Service suspended for overdue payment
    ChargeStatus Integer Billing status

    1: Normal
    2: Expired
    3: Terminated
    4: Assigning
    5: Failed to assign
    Note: This field may return null, indicating that no valid values can be obtained.
    EnableGrafana Integer Whether Grafana is enabled
    0: Disabled
    1: Enabled
    GrafanaURL String Grafana dashboard URL
    Note: This field may return null, indicating that no valid values can be obtained.
    InstanceChargeType Integer Instance billing mode. Valid values:

    2: Monthly subscription
    3: Pay-as-you-go
    SpecName String Specification name
    Note: This field may return null, indicating that no valid values can be obtained.
    DataRetentionTime Integer Storage period
    Note: This field may return null, indicating that no valid values can be obtained.
    ExpireTime String Expiration time of the purchased instance
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Auto-renewal flag

    0: Auto-renewal not enabled
    1: Auto-renewal enabled
    2: Auto-renewal prohibited
    -1: Invalid
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the details of a TMP instance

    This example shows you how to query the details of a TMP instance.

    Input Example

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

{
    "InstanceId": "xx"
}

    Output Example

    {
    "Response": {
        "InstanceStatus": 0,
        "VpcId": "xx",
        "AutoRenewFlag": 0,
        "InstanceId": "xx",
        "ExpireTime": "xx",
        "SpecName": "xx",
        "InstanceChargeType": 0,
        "RequestId": "xx",
        "EnableGrafana": 0,
        "DataRetentionTime": 0,
        "GrafanaURL": "xx",
        "SubnetId": "xx",
        "InstanceName": "xx",
        "ChargeStatus": 0
    }
}

    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
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.Param InvalidParameter.Param
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource is not found.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy