文档首页/ 密码安全中心 DEW/ API参考/ API/ 管理加密密钥/ 密钥空间/ 查询密钥使用流 - ShowKeyUsageFlow
更新时间：2026-11-06 GMT+08:00
查看PDF
分享

查询密钥使用流 - ShowKeyUsageFlow

功能介绍

查询指定密钥空间下指定密钥的使用流关系图，返回节点和边的图结构。

  • 节点按类型分组：vpc（VPC节点，含ECS、CCE子节点）、custom（接入点节点）、modelarts（ModelArts节点）、policy（策略节点）、unknown_node（未知起点节点）、key（密钥节点）。

  • 边表示使用流关系：起点节点到策略节点、策略节点到密钥节点。

  • 该接口仅支持查询已记录使用流关系的密钥，若密钥不存在使用流记录，则返回空的节点和边。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    kms:cmk:getKeyUsageFlow

    Read

    KeyId *

    -

    -

    -

URI

GET /v1.0/{project_id}/kms/key-spaces/usage-flow

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于唯一标识用户项目。可参考获取项目ID获取，以IAM服务接口返回值为准

约束限制：

不涉及

取值范围：

字符长度32-32。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

keyspace_id

是

String

参数解释：

密钥空间ID

约束限制：

满足正则表达式^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

取值范围：

不涉及

默认取值：

不涉及

key_id

是

String

参数解释：

密钥ID

约束限制：

满足正则表达式^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值），以IAM服务查询用户Token接口为准

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

nodes

Array of nodes objects

参数解释：

使用流图节点列表，当前固定包含一个元素，元素内按类型分组展示各类节点

取值范围：

不涉及

edges

Array of edges objects

参数解释：

使用流关系边列表，表示起点节点到策略节点、策略节点到密钥节点的使用流关系

取值范围：

不涉及
表5 nodes

参数

参数类型

描述

key

Object

参数解释：

密钥节点

取值范围：

不涉及
表6 edges

参数

参数类型

描述

source

String

参数解释：

边起点节点ID

取值范围：

不涉及

target

String

参数解释：

边终点节点ID

取值范围：

不涉及

请求示例

无

响应示例

无

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 密钥空间

相关文档