遍历AccessKey

接口描述

按照一定条件遍历当前账号所能查看的部分或所有普通AccessKey。

请求说明

协议 方法 PATH 说明
HTTPS GET /openapi/v1/pms/accesskeys 仅超级AccessKey可调用

PATH参数

无

URL参数

参数 类型 必填 说明
size int 否 分页大小，最大值为10000
page int 否 页数，最小值为1
wheres string 否 参见WHERES参数
accesskey_id string 是 参见签名认证
expires int 是 参见签名认证
signature string 是 参见签名认证

wheres允许填入的k：

参数 类型 说明
id string AccessKey ID
state int AccessKey状态
expire_time int 过期时间
group_acl int 分组访问权限
bandwidth_limit number 带宽限制
remark string 备注
create_time string 创建时间

请求示例

GET https://open.vzicloud.com/openapi/v1/pms/accesskeys?page=1&size=10&accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1

返回说明

返回参数

参数 类型 说明
size int 当前分页大小
page int 当前分页页码
total int 符合条件的AccessKey总数
items list AccessKey列表
+ id string AccessKey ID
+ secret string AccessKey密钥
+ state int AccessKey状态 (0:启用, 1:禁用)
+ group_acl int 分组访问控制 (0:允许访问所有分组, 1:仅允许访问指定分组)
+ group_ids array 允许访问的分组ID数组
+ allowed_apis array 允许调用的API列表
+ bandwidth_limit number 带宽限制(Mbps)
+ expire_time int 过期时间戳
+ remark string 备注
+ create_time string 创建时间
+ update_time string 更新时间

注：返回参数里可能还包含其他信息但未在上面的表格内列出，请勿使用！

返回示例

{
    "page": 1,
    "total": 2,
    "items": [
        {
            "id": "8d9EsDAD2115Q5PM8tuP6g1IdAglkayp",
            "secret": "xHWp8Z1GQK2nY3m4V5B6N7M8L9K0J1H2",
            "state": 1,
            "group_acl": 1,
            "group_ids": [1, 2, 3],
            "allowed_apis": [1, 2, 3, 4, 5],
            "bandwidth_limit": 10.5,
            "expire_time": 1735689600,
            "remark": "测试AccessKey",
            "create_time": "2021-06-18 11:44:03.575794",
            "update_time": "2021-06-18 11:44:03.575794"
        },
        {
            "id": "9e0FtEBE3226R6QN9uvQ7h2JeBlmlbzq",
            "secret": "yIXq9A2HRL3oZ4n5W6C7O8N9M0L1K2I3",
            "state": 1,
            "group_acl": 0,
            "group_ids": [],
            "allowed_apis": [1, 2, 3],
            "bandwidth_limit": 5.0,
            "expire_time": 1767225600,
            "remark": "生产环境AccessKey",
            "create_time": "2021-08-11 13:55:42.007764",
            "update_time": "2021-08-11 13:55:42.007764"
        }
    ],
    "size": 10000
}

results matching ""

    No results matching ""