创建AccessKey

接口描述

创建一个新的普通AccessKey。

请求说明

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

PATH参数

无

URL参数

参数	类型	必填	说明
accesskey_id	string	是	参见签名认证
expires	int	是	参见签名认证
signature	string	是	参见签名认证

HTTP请求头

字段	值
Content-Type	application/json

请求参数

请求参数以Json格式放置于Body中，如下：

参数	类型	必填	说明
expire_time	int	是	过期时间戳 (0-4102415999)
group_acl	int	否	分组访问控制 (0:允许访问所有分组, 1:仅允许访问指定分组)
group_ids	array	否	允许访问的分组ID数组
bandwidth_limit	number	否	带宽限制(Mbps)，必须是0.25的倍数，0：不允许取流；1048576：表示不限制
allowed_apis	array	否	允许调用的API列表
state	int	否	AccessKey状态 (0:启用, 1:禁用)
remark	string	否	备注

请求示例

POST https://open.vzicloud.com/openapi/v1/pms/accesskeys?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Host: open.vzicloud.com
Content-Length: 200
Content-Type: application/json

{
  "expire_time": 1735689600,
  "group_acl": 1,
  "group_ids": [1, 2, 3],
  "bandwidth_limit": 10.5,
  "allowed_apis": [1, 2, 3, 4, 5],
  "state": 0,
  "remark": "测试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	更新时间

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

返回示例

{
  "id": "8d9EsDAD2115Q5PM8tuP6g1IdAglkayp",
  "secret": "xHWp8Z1GQK2nY3m4V5B6N7M8L9K0J1H2",
  "state": 0,
  "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"
}

results matching ""

No results matching ""