接口功能介绍
为指定实例的创建新的令牌。
接口定义
接口名称 | 创建实例令牌 |
---|---|
承载协议 | HTTPS |
承载网络 | 外网 |
请求方式 | Post |
数据格式 | |
约束 | 实例处于运行状态 |
测试环境接口URL | https://influxdb-global.ctapi-test.ctyun.cn/v1/console/openapi/token/create |
生产环境接口URL | https://influxdb-global.ctapi.ctyun.cn/v1/console/openapi/token/create |
请求参数
header参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
regionId | 是 | header | String | 当前实例所属资源池 |
请求体body参数
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
spuInstId | 是 | body | String | 实例id |
tokenName | 是 | body | string | token名称 |
tokenType | 是 | body | string | tokenType 令牌类型:1:全部权限(Bucket+Telegraf), 2:读/写(Bucket权限) |
tokenAuthorities | 否 | body | object[] | 令牌类型为 "1" 该参数非必须字段,令牌类型为"2" 该参数为必须字段 |
description | 否 | body | string | token描述 |
表tokenAuthorities
参数名 | 是否必填 | 位置 | 参数类型 | 说明 |
---|---|---|---|---|
bucketId | 是 | body | string | bucketId |
isRead | 是 | body | boolean | true-创建的令牌对当前bucket具有读权限,false-创建的令牌对当前bucket不具有读权限 |
isWrite | 是 | body | boolean | true-创建的令牌对当前bucket具有写权限,false-创建的令牌对当前bucket不具有写权限 |
响应结果
响应Body参数
名称 | 类型 | 说明 | 下级对象 |
---|---|---|---|
code | Integer | 返回状态码 | |
message | String | 描述 | |
data | Long | number | tokenId |
请求示例
请求头header
"regionId","39h54mest675e11ea91fc9432qw12867"
请求体Body
{
"spuInstId": "",
"tokenName": "",
"tokenType": "",
"tokenAuthorities": [
{
"bucketId": "",
"bucketName": "",
"isRead": false,
"isWrite": false
}
],
"description": ""
}
响应示例
{
"data": 1,
"code": 0,
"message": ""
}
状态码
状态码 | 描述 |
---|---|
0 | 请求成功 |