获取Web站点列表

最近更新时间: 2026-09-17 00:02:48

1. 接口描述

接口请求域名： cwp.api3.fincloud.tencent.cn。

获取Web站点列表

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

接口更新时间：2022-09-28 15:55:30。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeAssetWebLocationList
Version	是	否	String	公共参数，本接口取值：2018-02-28
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
By	否	否	String	可选排序：[FirstTime
Filters	否	否	Array of Filter	过滤条件。 IP - String - 是否必填：否 - 主机ip MachineName - String - 是否必填：否 - 主机名称 InstanceID - string - 是否必填：否 - 实例ID Name - String - 是否必填：否 - 域名 User - String - 是否必填：否 - 运行用户 Port - uint64 - 是否必填：否 - 站点端口 Proto - uint64 - 是否必填：否 - 站点协议：1:HTTP,2:HTTPS ServiceType - uint64 - 是否必填：否 - 服务类型： 1:Tomcat 2：Apache 3:Nginx 4:WebLogic 5:Websphere 6:JBoss 7:WildFly 8:Jetty 9:IHS 10:Tengine OsType - String - 是否必填：否 - windows/linux OsName -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口值 ) 示例值：查看
Limit	否	否	Uint64	需要返回的数量，默认为10，最大值为100 示例值： 10
Offset	否	否	Uint64	偏移量，默认为0。示例值： 12
Order	否	否	String	排序方式，asc升序或 desc降序示例值： asc
Quuid	否	否	String	查询指定Quuid主机的信息示例值： acdd5474-6360-4fd4-bfc7-843162cb8116

3. 输出参数

参数名称	类型	描述
Locations	Array of AssetWebLocationBaseInfo	站点列表示例值：查看
Total	Uint64	记录总数示例值： 12
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InternalError	内部错误。
MissingParameter	缺少参数错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 获取Web站点列表

输入示例

POST / HTTP/1.1
Host: cwp.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeAssetWebLocationList
<Public request parameters>

{}

输出示例

{
 "Response": {
  "Locations": [
   {
    "FirstTime": "2024-10-11 12:23:34",
    "Id": "wfwfw",
    "IsNew": 0,
    "MachineExtraInfo": {
     "HostName": "test-name",
     "InstanceID": "ins-aj28fjz",
     "NetworkName": "vpc-dsd4",
     "NetworkType": 0,
     "PrivateIP": "10.0.0.11",
     "WanIP": "110.84.0.11"
    },
    "MachineIp": "10.0.0.11",
    "MachineName": "test-name",
    "MachineWanIp": "110.84.0.11",
    "MainPath": "/root",
    "MainPathOwner": "/root",
    "Name": "test-name",
    "OsInfo": "CentOs Bit64",
    "PathCount": 1,
    "Permission": "",
    "Port": "22",
    "ProjectId": 1,
    "Proto": "tcp",
    "Quuid": "acdd5474-6360-4fd4-bfc7-843162cb8116",
    "ServiceType": "nginx",
    "Tag": [
     {
      "Name": "test-name",
      "Rid": 0,
      "TagId": 1
     }
    ],
    "UpdateTime": "2024-10-11 12:23:34",
    "User": "root",
    "Uuid": "acdd5474-6360-4fd4-bfc7-843162cb8116"
   }
  ],
  "RequestId": "37b6df34-68f1-4ab8-a3d8-7b89de604c82",
  "Total": 1
 }
}