文档中心>API 中心

获取TMP实例详情

最近更新时间:2024-07-18 01:16:11

我的收藏

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

获取TMP实例详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePrometheusInstanceDetail。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:prom-abc

3. 输出参数

参数名称 类型 描述
InstanceId String 实例ID
示例值:prom-abc
InstanceName String 实例名称
示例值:test-Prometheus
VpcId String VPC ID
示例值:vpc-abc
SubnetId String 子网 ID
示例值:subnet-abc
InstanceStatus Integer 实例业务状态。取值范围:

1:正在创建
2:运行中
3:异常
4:重建中
5:销毁中
6:已停服
8:欠费停服中
9:欠费已停服
示例值:3
ChargeStatus Integer 计费状态

1:正常
2:过期
3:销毁
4:分配中
5:分配失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableGrafana Integer 是否开启 Grafana
0:不开启
1:开启
示例值:1
GrafanaURL String Grafana 面板 URL
注意:此字段可能返回 null,表示取不到有效值。
示例值:http://10.0.0.1:3000
InstanceChargeType Integer 实例计费模式。取值范围:

2:包年包月
3:按量
示例值:3
SpecName String 规格名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:abc
DataRetentionTime Integer 存储周期
注意:此字段可能返回 null,表示取不到有效值。
示例值:15
ExpireTime String 购买的实例过期时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024/07/16 16:06:31
AutoRenewFlag Integer 自动续费标记

0:不自动续费
1:开启自动续费
2:禁止自动续费
-1:无效
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询TMP实例详情

查询TMP实例详情

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusInstanceDetail
<公共请求参数>

{
    "InstanceId": "abc"
}

输出示例

{
    "Response": {
        "InstanceId": "prom-skdfj",
        "InstanceName": "test-prom",
        "VpcId": "vpc-sjdh",
        "SubnetId": "subnet-kdhe",
        "InstanceStatus": 3,
        "ChargeStatus": 1,
        "EnableGrafana": 0,
        "GrafanaURL": "http://djeb:9000",
        "InstanceChargeType": 0,
        "SpecName": "name-sjdb",
        "DataRetentionTime": 15,
        "ExpireTime": "2024-07-16 16:28:54",
        "AutoRenewFlag": 0,
        "RequestId": "skdbfdi-akenfhl"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ComponentClientCommon FailedOperation.ComponentClientCommon
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Param InvalidParameter.Param
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。