查询应用列表

最近更新时间:2024-10-30 19:38:55

我的收藏

1. 接口描述

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

查询应用列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAssetAppList。
Version String 公共参数,本接口取值:2018-02-28。
Region String 公共参数,此参数为可选参数。
Quuid String 查询指定Quuid主机的信息
示例值:24c9be55-c743-4a75-a5c7-2a2912341234
Filters.N Array of AssetFilters 过滤条件。
  • AppName- string - 是否必填:否 - 应用名搜索
  • IP - String - 是否必填:否 - 主机ip
  • MachineName - String - 是否必填:否 - 主机名称
  • InstanceID - string - 是否必填:否 - 实例ID
  • Type - int - 是否必填:否 - 类型 : 仅linux
    0: 全部
    1: 运维
    2 : 数据库
    3 : 安全
    4 : 可疑应用
    5 : 系统架构
    6 : 系统应用
    7 : WEB服务
    99:其他
  • OsType - uint64 - 是否必填:否 - windows/linux
  • Os -String 是否必填: 否 - 操作系统( DescribeMachineOsList 接口 值 )

  • 示例值:1
    Limit Integer 需要返回的数量,默认为10,最大值为100
    示例值:1
    Offset Integer 偏移量,默认为0。
    示例值:1
    Order String 排序方式,asc升序 或 desc降序
    示例值:asc
    By String 排序方式:[FirstTime|ProcessCount]
    示例值:1

    3. 输出参数

    参数名称 类型 描述
    Apps Array of AssetAppBaseInfo 应用列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    Total Integer 总数量
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询应用列表

    输入示例

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

    输出示例

    {
        "Response": {
            "Apps": [
                {
                    "MachineIp": "10.0.0.11",
                    "MachineName": "test-name",
                    "MachineWanIp": "110.84.0.11",
                    "Uuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "Quuid": "24c9be55-c743-4a75-a5c7-2a2912341234",
                    "ProjectId": 1,
                    "Tag": [
                        {
                            "Rid": 0,
                            "Name": "test-name",
                            "TagId": 1
                        }
                    ],
                    "Name": "test-name",
                    "Type": 1,
                    "BinPath": "/root",
                    "OsInfo": "CentOs Bit64",
                    "ProcessCount": 1,
                    "Desc": "",
                    "Version": "0.1.1",
                    "ConfigPath": "/root",
                    "FirstTime": "2024-10-11 12:23:34",
                    "UpdateTime": "2024-10-11 12:23:34",
                    "IsNew": 0,
                    "MachineExtraInfo": {
                        "WanIP": "110.84.0.11",
                        "PrivateIP": "10.0.0.11",
                        "NetworkType": 0,
                        "NetworkName": "vpc-12341234",
                        "InstanceID": "ins-aj28fjz",
                        "HostName": "test-name"
                    }
                }
            ],
            "Total": 1,
            "RequestId": "37b6df34-68f1-4ab8-a3d8-7b89de604c82"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFormat 参数格式错误。
    InvalidParameter.MissingParameter 参数缺失。
    InvalidParameter.ParsingError 参数解析错误。
    InvalidParameterValue 参数取值错误。
    MissingParameter 缺少参数错误。
    ResourceNotFound 资源不存在。