日志服务查询实体列表

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

分页查询资源图谱实体列表。Filters 支持 Product / EntityClassName / Keyword 过滤；TagFilter 由于结构特殊（key 单选 + values 多选）独立成字段。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeResourceGraphEntities。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
ResourceGraphId	是	String	资源图谱id 示例值：badc7d81-70a6-4979-aa54-59ae51a4870a
Filters.N	否	Array of Filter	Product 按【产品分组】精确匹配，可用参数：all / business_service / tke / cdb / redis / mongodb 。类型：String。必选：否 EntityClassName 按【实体类型】精确匹配，可用参数：all / app.service.application / tc.tke.cluster / tc.tkex.project / tc.cdb.instance / tc.redis.instance / tc.mongodb.instance / k8s.cluster / k8s.namespace / k8s.node / k8s.pod / k8s.ip / k8s.service / k8s.deployment / k8s.statefulset / k8s.statefulsetplus / k8s.daemonset / k8s.storageclass / k8s.persistentvolume / k8s.persistentvolumeclaim / k8s.secret。类型：String。必选：否 Name 按【实体名称】模糊匹配。类型：String。必选：否 ResourceId 按【实体资源id】精确匹配。类型：String。必选：否注意：每次请求的 Filters 上限 10。
NextCursor	否	String	查询偏移示例值：db2a0834979ca3769b03e4493249e40f
Limit	否	Integer	分页单页数量，默认 20，最大 100 示例值：3
FromTime	否	Integer	查询开始时间单位：毫秒示例值：1783308688
ToTime	否	Integer	查询结束时间单位：毫秒示例值：1783319488

3. 输出参数

参数名称	类型	描述
EntityInfos	Array of EntityInfo	实体列表
HasMore	Integer	是否还有下一页枚举值： 0：没有下一页 1：还有下一页示例值：0
NextCursor	String	分页的游标，有值则下次分页请求原样带上，无值则表示无下一页示例值：31ece2107728b7bca286180b2db53582
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 带过滤条件查询

输入示例

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

{
    "ResourceGraphId": "badc7d81-70a6-4979-aa54-59ae51a4870a",
    "Filters": [
        {
            "Key": "Product",
            "Values": [
                "tke"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "EntityInfos": [
            {
                "Attributes": [
                    {
                        "Key": "cluster_id",
                        "Value": "cls-3js81lg0"
                    }
                ],
                "Domain": "k8s",
                "EntityClassName": "k8s.node",
                "EntityId": "0db13f1dc7b4e58d90cb1e00d506516e",
                "EntityName": "172.16.0.37",
                "Product": "",
                "RelatedLogTopics": [],
                "Tags": []
            }
        ],
        "HasMore": 0,
        "NextCursor": "",
        "RequestId": "32666ac9-87d7-49ab-aa01-98c569817625"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。

查询实体列表

本页目录：