tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSourceAsset

Last updated: 2023-05-04 17:40:10

1. API Description

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

This API is used to get all asset information of an asset group.

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: DescribeSourceAsset.
Version Yes String Common Params. The value used for this API: 2019-09-04.
Region No String Common Params. This parameter is not required for this API.
FuzzySearch No String Fuzzy search
InsType No String Asset type. 1: public network; 2: private network
ChooseType No String If ChooseType is 1, grouped assets are queried; if ChooseType is not 1, non-grouped assets are queried
Zone No String Region
Limit No Integer Maximum number of results returned per page. For example, if it is set to 10, 10 results will be returned at most.
Offset No Integer Offset of search results

3. Output Parameters

Parameter Name Type Description
ZoneList Array of AssetZone Region collection
Data Array of InstanceInfo Data
Total Integer Total number of returned data
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting all asset information of an asset group

Input Example

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

{
    "InsType": "xx",
    "ChooseType": "xx",
    "FuzzySearch": "xx",
    "Zone": "xx"
}

Output Example

{
    "Response": {
        "Total": 2,
        "Data": [
            {
                "LeakNum": "xx",
                "InsSource": "xx",
                "VpcId": "xx",
                "PortNum": "xx",
                "InstanceId": "xx",
                "Region": "xx",
                "ResourcePath": [
                    "xx"
                ],
                "PrivateIp": "xx",
                "PublicIp": "xx",
                "SubnetId": "xx",
                "VPCName": "xx",
                "AppId": "xx",
                "InsType": 0,
                "InstanceName": "xx"
            }
        ],
        "RequestId": "xx",
        "ZoneList": [
            {
                "ZoneEng": "xx",
                "Zone": "xx"
            }
        ]
    }
}

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
FailedOperation Operation failed.
InvalidParameter Invalid parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy