资源详情

最近更新时间:2024-12-06 01:14:07

我的收藏

1. 接口描述

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

资源详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiscoveredResource。
Version String 公共参数,本接口取值:2022-08-02。
Region String 公共参数,详见产品支持的 地域列表
ResourceId String 资源ID
示例值:ins-sada
ResourceType String 资源类型
示例值:QCS::CVM::Instance
ResourceRegion String 资源地域
示例值:ap-hangzhou

3. 输出参数

参数名称 类型 描述
ResourceId String 资源Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:instance-123
ResourceType String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:QCS::CVM::Instance
ResourceName String 资源名
注意:此字段可能返回 null,表示取不到有效值。
示例值:cvm
ResourceRegion String 资源地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou
ResourceZone String 资源可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-1
Configuration String 资源配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"InstanceState":"STOPPED","InstanceName":"未命名3","InstanceId":"ins-jrkgnbhq","InstanceType":"xxx","VirtualPrivateCloud":{"VpcId":"xxx"}
ResourceCreateTime String 资源创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-11-16 09:28:13
Tags Array of Tag 资源标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "tagKey": "运营部", "tagValue": "开发部" } ]
UpdateTime String 资源更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2024-12-05 19:14:53
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取资源详情

获取资源详情

输入示例

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

{
    "ResourceId": "ins-2avl1cxx",
    "ResourceType": "QCS::CVM::Instance",
    "ResourceRegion": "ap-guangzhou"
}

输出示例

{
    "Response": {
        "RequestId": "2ea2d804-d278-4631-b04d-70bd40e1a478",
        "Configuration": "{\"InstanceState\":\"RUNNING\",\"InstanceName\":\"未命名\",\"InstanceId\":\"ins-111\",\"InstanceType\":\"S5.SMALL2\",\"VirtualPrivateCloud\":{\"VpcId\":\"vpc-333\",\"SubnetId\":\"subnet-qxupkefw\",\"AsVpcGateway\":false,\"PrivateIpAddresses\":null,\"Ipv6AddressCount\":0},\"PrivateIpAddresses\":[\"111\"],\"PublicIpAddresses\":null,\"OsName\":\"TencentOS Server 4 for x86_64\",\"Memory\":2,\"CPU\":1,\"InternetAccessible\":{\"InternetChargeType\":\"\",\"InternetMaxBandwidthOut\":0,\"PublicIpAssigned\":false,\"BandwidthPackageId\":\"\"},\"ImageId\":\"img-333\",\"InstanceChargeType\":\"PREPAID\",\"SecurityGroupIds\":[\"sg-222\"],\"DataDisks\":null,\"SystemDisk\":{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskId\":\"disk-auh4557w\"},\"ExpiredTime\":\"2024-12-28T08:07:12Z\",\"RenewFlag\":\"NOTIFY_AND_MANUAL_RENEW\",\"LatestOperation\":\"\",\"Placement\":{\"ProjectId\":0},\"LatestOperationState\":\"\",\"CamRoleName\":\"\"}",
        "ResourceCreateTime": "2024-11-28 16:07:12",
        "ResourceId": "ins-2avl1cxx",
        "ResourceName": "未命名",
        "ResourceRegion": "ap-guangzhou",
        "ResourceType": "QCS::CVM::Instance",
        "ResourceZone": "",
        "Tags": [],
        "UpdateTime": "2024-11-28 16:08:36"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
ResourceNotFound.ResourceNotExist 资源不存在。