获取密钥对列表 ListAdbKey--云手机-火山引擎

文档中心

立即注册

导航

获取密钥对列表 ListAdbKey

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.06.30 18:11:44

获取指定业务内已创建的密钥对。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListAdbKey
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25
product_id	Query	String	是	筛选条件，业务 ID	可在「云手机控制台-业务管理-业务详情」中获取
key_id	Query	Int64	否	筛选条件，密钥对 ID	可在「云手机控制台-业务管理-密钥对」中获取
key_name	Query	String	否	筛选条件，密钥对名称	可在「云手机控制台-业务管理-密钥对」中获取
offset	Query	Int64	否	分页偏移量	例：0
count	Query	Int64	否	单页数量	例：10

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	Int64	返回的密钥对数量
row	Array of objects	查询到的密钥对信息列表，参考以下 `List<AdbKey>` 结构说明

List<AdbKey> 结构说明

字段	类型	说明
product_id	String	密钥对所属业务 ID
key_id	Int64	密钥对 ID
key_name	String	密钥对名称
key_desc	String	密钥对描述
auth_type	Int32	用户权限类型： 1（root） 2（user）
fingerprint	String	公钥指纹
create_at	Long	创建时间，秒级时间戳
update_at	Long	更新时间，秒级时间戳
bind_instance_num	Int32	密钥对绑定的实例数量

示例

请求示例

GET https://open.volcengineapi.com?Action=ListAdbKey
&Version=2020-10-25
&product_id=1471432326763xxxxxx
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListAdbKey",
        "Region": "cn-north-1",
        "RequestId": "2022062815172301017423503803E66CCE",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "row": [
            {
                "product_id": "1467739678185xxxxxx",
                "key_id": 11466,
                "key_name": "docker_user_adbkey",
                "key_desc": "本地的密钥",
                "auth_type": 1,
                "fingerprint": "xx:xx:xx:xx:xx:d8:c8:ae:7e:c1:0c:10:xx:xx:xx:xx",
                "create_at": 1648532424,
                "update_at": 1648632424,
                "bind_instance_num": 3
            }
        ],
        "total": 1
    }
}