tencent cloud

Feedback

DescribeDiscoveredResource

Last updated: 2024-12-02 15:06:12

1. API Description

Domain name for API request: config.intl.tencentcloudapi.com.

Resource details.

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: DescribeDiscoveredResource.
Version Yes String Common Params. The value used for this API: 2022-08-02.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ResourceId Yes String Resource ID
ResourceType Yes String Resource type
ResourceRegion Yes String Resource region

3. Output Parameters

Parameter Name Type Description
ResourceId String Resource ID

Note: This field may return null, indicating that no valid value is found.
ResourceType String Resource type

Note: This field may return null, indicating that no valid value is found.
ResourceName String Resource Name

Note: This field may return null, indicating that no valid value is found.
ResourceRegion String Resource region

Note: This field may return null, indicating that no valid value is found.
ResourceZone String Resource availability zone
Note: This field may return null, indicating that no valid value is found.
Configuration String Resource configuration

Note: This field may return null, indicating that no valid value is found.
ResourceCreateTime String Resource creation time

Note: This field may return null, indicating that no valid value is found.
Tags Array of Tag Resource tag

Note: This field may return null, indicating that no valid value is found.
UpdateTime String Resource update time
Note: This field may return null, indicating that no valid value is found.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting Resource Details

This example shows you how to get resource details.

Input Example

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

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

Output Example

{
    "Response": {
        "RequestId": "2ea2d804-d278-4631-b04d-70bd40e1a478",
        "Configuration": "{\"InstanceState\":\"RUNNING\",\"InstanceName\":\"Unnamed\",\"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": "Unnamed"
        "ResourceRegion": "ap-guangzhou",
        "ResourceType": "QCS::CVM::Instance",
        "ResourceZone": "",
        "Tags": [],
        "UpdateTime": "2024-11-28 16:08:36"
    }
}

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
InvalidParameter Parameter error.
ResourceNotFound.ResourceNotExist The resource does not exist.