API 中心

没有找到相关结果，请重新输入

云服务器

3.0

云硬盘

3.0

容器服务

3.0

弹性伸缩

3.0

负载均衡

3.0

私有网络

3.0

云函数

3.0

批量计算

3.0

专线接入

3.0

对象存储

微服务平台 TSF

3.0

文件存储

3.0

消息队列 CKafka 版

3.0

全站加速网络

3.0

日志服务

3.0

云数据库 MySQL

3.0

云数据库 MariaDB

3.0

云数据库 SQL Server

3.0

云数据库 PostgreSQL

3.0

内容分发网络 CDN

3.0

网络流日志

云数据库 Redis®

3.0

云数据库 Memcached

3.0

云数据库 MongoDB

3.0

TDSQL MySQL版

3.0

全球应用加速

3.0

数据传输服务

3.0

腾讯云可观测平台

3.0

云拨测

3.0

腾讯云区块链服务平台 TBaaS

3.0

主机安全

3.0

访问管理

3.0

DDoS 防护

3.0

标签

3.0

Web 应用防火墙

3.0

密钥管理系统

3.0

域名注册

3.0

操作审计

3.0

SSL 证书

3.0

数据万象

短信

3.0

NLP 技术

3.0

云点播

3.0

云加密机

3.0

云市场

3.0

云安全中心

3.0

云开发 CloudBase

3.0

集团账号管理

3.0

人脸识别

3.0

Elasticsearch Service

3.0

流计算 Oceanus

3.0

腾讯云数据仓库 TCHouse-P

3.0

口语评测（基础版）

3.0

文字识别

3.0

图像识别

3.0

媒体处理

3.0

云直播

3.0

云联络中心

3.0

机器翻译

3.0

物联网通信

3.0

人脸融合

3.0

弹性 MapReduce

3.0

游戏数据库 TcaplusDB

3.0

游戏多媒体引擎

3.0

腾讯云 BI

3.0

实时音视频

3.0

TI-ONE 训练平台

3.0

渠道合作伙伴

3.0

数据安全审计

3.0

数据安全治理中心

3.0

高性能应用服务 HAI

3.0

设备安全

3.0

微瓴同业开放平台

3.0

腾讯云数据仓库 TCHouse-C

3.0

消息队列 RocketMQ 版

3.0

商场客留大数据

3.0

腾讯云健康看板

3.0

数据加速器 GooseFS

3.0

智能视图计算平台

3.0

云压测

3.0

大模型图像创作引擎

3.0

腾讯健康组学平台

3.0

实时互动-工业能源版

3.0

文旅客情大数据

3.0

声音复刻

3.0

云数据库 KeeWiDB

3.0

视频审核

语音识别

3.0

消息队列 MQTT 版

3.0

图片处理

图片审核

消息队列 CMQ 版

安全湖

3.0

智能全局流量管理

3.0

暴露面管理服务

3.0

多媒体处理

弹性公网 IPv6

云托付物理服务器

3.0

腾讯云微搭低代码

3.0

消息队列 RabbitMQ 版

3.0

统一 Catalog 服务

3.0

知识引擎原子能力

3.0

商业流程服务

3.0

AI 临床助手

3.0

配置审计

3.0

腾讯同传

3.0

腾讯混元大模型

3.0

腾讯云数据仓库 TCHouse-D

3.0

iOA 零信任安全管理系统

3.0

分布式身份

3.0

腾讯云智能体开发平台

3.0

向量数据库

3.0

大模型视频创作引擎

3.0

实时互动-教育版

3.0

专属可用区

3.0

云应用

3.0

控制中心

3.0

腾讯云 CA

3.0

网关负载均衡

3.0

智能导诊

3.0

音视频终端 SDK（腾讯云视立方）

3.0

前端性能监控

3.0

Cloud Studio（云端 IDE）

3.0

互动白板

3.0

物联网智能视频服务（行业版）

3.0

自动化助手

3.0

视频内容安全

3.0

邮件推送

3.0

安全凭证服务

3.0

音频内容安全

3.0

轻量应用服务器

3.0

人像变换

3.0

人脸试妆

3.0

云游戏

3.0

智能创作

3.0

容器镜像服务

3.0

凭据管理系统

3.0

云防火墙

3.0

注册配置治理

3.0

数据库智能管家 DBbrain

3.0

语音消息

3.0

文本内容安全

3.0

验证码

3.0

边缘计算机器

3.0

云 HDFS

3.0

证书监控 SSLPod

3.0

物联网开发平台

3.0

英文作文批改

3.0

语音合成

3.0

人脸核身

3.0

数学作业批改

3.0

TDSQL-C MySQL 版

3.0

计费相关

3.0

数据湖计算 DLC

3.0

物联网智能视频服务（消费版）

3.0

风险识别 RCE

3.0

智能媒资托管

3.0

地域管理系统

3.0

数据开发治理平台 WeData

3.0

云托管 CloudBase Run

3.0

账号风控平台

3.0

小程序安全检测

3.0

腾讯安心平台

3.0

云数据库独享集群

3.0

应用性能监控

3.0

本地专用集群

3.0

运维安全中心（堡垒机）

3.0

边缘安全加速平台 EO

3.0

应用云渲染

3.0

软件成分分析

3.0

混沌演练平台

3.0

弹性微服务

3.0

TDSQL-C PostgreSQL 版

3.0

腾讯电子签

3.0

高性能计算平台

3.0

事件总线

3.0

容器安全服务

3.0

视频理解

3.0

服务网格

3.0

云顾问

3.0

数字身份管控平台（员工版）

3.0

图片内容安全

3.0

医疗报告结构化

3.0

DNSPod

3.0

私有域解析 Private DNS

3.0

多网聚合加速

3.0

文本审核

文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>密钥管理系统>密钥相关接口>获取数据密钥列表详情

获取数据密钥列表详情

最近更新时间：2025-06-26 01:27:11

我的收藏

本页目录：

1. 接口描述

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

根据指定Offset和Limit获取数据密钥列表详情。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListDataKeyDetail。
Version 是 String 公共参数，本接口取值：2019-01-18。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 否 Integer 含义跟 SQL 查询的 Offset 一致，表示本次获取从按一定顺序排列数组的第 Offset 个元素开始，缺省为0
示例值：0
Limit 否 Integer 含义跟 SQL 查询的 Limit 一致，表示本次最多获取 Limit 个元素。缺省值为10，最大值为200
示例值：10
Role 否 Integer 根据创建者角色筛选，默认 0 表示用户自己创建的数据密钥， 1 表示授权其它云产品自动创建的数据密钥
示例值：0
OrderType 否 Integer 根据DataKey创建时间排序， 0 表示按照降序排序，1表示按照升序排序
示例值：0
KeyState 否 Integer 根据DataKey状态筛选， 0表示全部DataKey， 1 表示仅查询Enabled DataKey， 2 表示仅查询Disabled DataKey，3 表示查询PendingDelete 状态的DataKey(处于计划删除状态的Key)。
示例值：0
SearchKeyAlias 否 String 根据DataKeyId或者DataKeyName进行模糊匹配查询
示例值：lzctest
Origin 否 String 根据DateKey类型筛选， "TENCENT_KMS" 表示筛选密钥材料由KMS创建的数据密钥， "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型数据密钥，"ALL" 或者不设置表示两种类型都查询，大小写敏感。
示例值：ALL
HsmClusterId 否 String KMS 高级版对应的 HSM 集群 ID。
示例值：cls-hsm-3dflmo9g
KeyId 否 String 根密钥全局唯一标识符
示例值：93866e69-9755-11ef-8e65-52540089bc41
DataKeyLen 否 Integer 数据密钥的长度
示例值：16

3. 输出参数

参数名称 类型 描述
DataKeyMetadatas Array of DataKeyMetadata 返回的属性信息列表。
TotalCount Integer DataKey的总数量
示例值：10
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取数据密钥列表详情示例

输入示例

复制
复制成功
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDataKeyDetail
<公共请求参数>

{
    "SearchKeyAlias": "e6c1f360-4ceb-11f0-8428-52540073b995"
}

输出示例

复制
复制成功
{
    "Response": {
        "DataKeyMetadatas": [
            {
                "CreateTime": 1750323652,
                "CreatorUin": 100000007998,
                "DataKeyId": "e6c1f360-4ceb-11f0-8428-52540073b995",
                "DataKeyName": "eY66EuC61oAhm6qXyjZAPWhX0Gn9oe8g",
                "DeletionDate": 1750928452,
                "Description": "TestDateKey_01",
                "HsmClusterId": "",
                "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
                "KeyState": "PendingDelete",
                "NumberOfBytes": 1024,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/100000007998/e6c1f360-4ceb-11f0-8428-52540073b995"
            }
        ],
        "RequestId": "75bd39cb-1e80-4b54-9b83-b991b6f684d6",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 未授权的操作。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidHsmClusterId 无效的 HSM 集群 ID。
InvalidParameterValue.InvalidKeyId KeyId不合法。
ResourceUnavailable.CmkNotFound CMK不存在。
UnauthorizedOperation 未授权操作。

如果遇到产品相关问题，您可咨询 在线客服寻求帮助。

中国站
目录
返回顶部