tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAssetWebLocationList

Last updated: 2024-08-27 11:44:13

1. API Description

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

This API is used to obtain the list of Web sites.

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: DescribeAssetWebLocationList.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Quuid No String Query the information on the host with the specified QUUID
Filters.N No Array of Filter Filtering criteria
  • IP - String - required: no - host IP address
  • MachineName - String - required: no - host name
  • InstanceID - string - required: no - instance ID
  • Name - String - required: no - domain name
  • User - String - required: no - running user
  • Port - uint64 - required: no - site port
  • Proto - uint64 - required: no - site protocol: 1: HTTP; 2: HTTPS
  • ServiceType - uint64 - required: no - service type:
    1:Tomcat
    2: Apache
    3:Nginx
    4:WebLogic
    5:Websphere
    6:JBoss
    7:WildFly
    8:Jetty
    9:IHS
    10:Tengine
  • OsType - String - required: no - Windows/Linux
  • Os - String required: no - operating system (value of DescribeMachineOsList)
    		•
    Offset No Integer Offset. Default value: 0.
    Limit No Integer Number of entries to be returned. Default value: 10. Maximum value: 100.
    Order No String Sorting method: asc for ascending order or desc for descending order
    By No String Sorting method: [FirstTime|PathCount]

    3. Output Parameters

    Parameter Name Type Description
    Total Integer Total number of records
    Locations Array of AssetWebLocationBaseInfo Site list
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Obtaining Web Site List

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "Total": 1,
        "Locations": [
            {
                "Uuid": "abc",
                "Quuid": "abc",
                "MachineIp": "abc",
                "MachineWanIp": "abc",
                "MachineName": "abc",
                "OsInfo": "abc",
                "Name": "abc",
                "Port": "abc",
                "Proto": "abc",
                "ServiceType": "abc",
                "PathCount": 1,
                "User": "abc",
                "MainPath": "abc",
                "MainPathOwner": "abc",
                "Permission": "abc",
                "ProjectId": 1,
                "Tag": [
                    {
                        "Rid": 0,
                        "Name": "abc",
                        "TagId": 1
                    }
                ],
                "Id": "abc",
                "UpdateTime": "abc",
                "FirstTime": "abc",
                "IsNew": 0,
                "MachineExtraInfo": {
                    "WanIP": "abc",
                    "PrivateIP": "abc",
                    "NetworkType": 0,
                    "NetworkName": "abc",
                    "InstanceID": "abc",
                    "HostName": "abc"
                }
            }
        ],
        "RequestId": "abc"
    }
}

    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 Incorrect parameter.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy