帮你快速理解、总结文档立即下载

查询资源图谱列表

最近更新时间:2026-09-23 01:40:50
我的收藏

1. 接口描述

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

分页查询工作区列表,支持按 WorkAreaId / Name / Region 过滤。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeResourceGraphs。
Version 是 String 公共参数,本接口取值:2020-10-16。
Region 是 String 公共参数,详见产品支持的 地域列表。
Filters.N 否 Array of Filter
  • ResourceGraphId 按【资源图谱 ID】精确匹配。类型:String。必选:否
  • Name 按【资源图谱名称】模糊匹配。类型:String。必选:否
  • Status 按【状态】模糊匹配。类型:int。必选:否;0:初始化中;1:就绪;2:创建失败;3:删除中;5:删除失败
  • tagKey 按照【标签键】进行过滤。类型:String。必选:否
  • tag:tagKey 按照【标签键值对】进行过滤。tagKey 使用具体的标签键进行替换,例如 tag:exampleKey。类型:String。必选:否
注意:每次请求的 Filters 上限 10,Filter.Values 上限 100。
Offset 否 Integer

分页偏移量

默认值:0


示例值:0
Limit 否 Integer

分页单页数量

取值范围:[0, 100]

默认值:20


示例值:10

3. 输出参数

参数名称 类型 描述
ResourceGraphInfos Array of ResourceGraphInfo

资源图谱信息

TotalCount Integer

总数


示例值:20
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询资源图谱列表

输入示例

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

{}

输出示例

{
    "Response": {
        "ResourceGraphInfos": [
            {
                "CreateTime": 1784269960,
                "Name": "test-yangxyang11",
                "RelationLogset": {
                    "LogsetId": "ff768190-a5b0-48d1-8a5a-78f148a56422",
                    "LogsetName": "graph-logset-34b7ad8b-fb4c-42de-a7e1-2442202bad02"
                },
                "RelationTopics": [
                    {
                        "TopicId": "d4cf2dd5-3e50-43df-b21a-98406b509d87",
                        "TopicName": "graph-entity-log-topic",
                        "Type": "entity"
                    }
                ],
                "ResourceGraphId": "34b7ad8b-fb4c-42de-a7e1-2442202bad02",
                "Status": 1,
                "Tags": [],
                "UpdateTime": 1784269965
            }
        ],
        "TotalCount": 20,
        "RequestId": "d3251d25-b5fd-4c08-b13a-c6eea8fdd6f3"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 请求未授权。
FailedOperation 操作失败。
FailedOperation.TagConcurrentConflict 标签侧并发冲突
FailedOperation.TagQpsLimit 请求标签服务限频。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
UnsupportedOperation 操作不支持。