获取 Access Token(通用认证),当前仅西南-贵阳一、北京四支持 - CreateGeneralToken
功能介绍
获取 Access Token(通用认证),Token有效期为24小时
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/general/auth/token
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| install_key | 是 | String | 参数解释: 安装密钥 约束限制: 必填 取值范围: 格式为 ik_ 前缀 + 随机字符串 默认取值: 不涉及 |
| host_ip | 是 | String | 参数解释: 主机IP 约束限制: 必填。主机的私有IP地址 取值范围: 合法的 IPv4 或 IPv6 地址格式 默认取值: 不涉及 |
| hostname | 是 | String | 参数解释: 主机名 约束限制: 必填 取值范围: 字符长度1-255位 默认取值: 不涉及 |
| mac_address | 否 | String | 参数解释: MAC 地址 约束限制: 不涉及 取值范围: 格式为 XX:XX:XX:XX:XX:XX(6组十六进制,冒号分隔) 默认取值: 不涉及 |
| gateway_port | 是 | Integer | 参数解释: 网关端口 约束限制: 必填 取值范围: 1 ~ 65535 默认取值: 不涉及 |
| gateway_mode | 是 | String | 参数解释: 网关模式 约束限制: 必填 取值范围: 默认取值: 不涉及 枚举值: |
| gateway_bind | 是 | String | 参数解释: 网关绑定地址 约束限制: 必填 取值范围: 合法 IP 地址或域名格式 默认取值: 不涉及 |
| container_id | 否 | String | 参数解释: 容器 ID,用于标识运行在容器环境中的 Agent 约束限制: 可选参数。仅在容器场景下传入 取值范围: 字符长度1-128位 默认取值: 不涉及 |
| cluster_id | 否 | String | 参数解释: 集群 ID 约束限制: 可选参数。仅在集群场景下传入 取值范围: 字符长度1-128位 默认取值: 不涉及 |
| namespace_id | 否 | String | 参数解释: 命名空间 ID 约束限制: 可选参数。仅在集群场景下传入 取值范围: 字符长度1-128位 默认取值: 不涉及 |
| pod_id | 否 | String | 参数解释: POD ID 约束限制: 可选参数。仅在集群场景下传入 取值范围: 字符长度1-128位 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| access_token | String | 参数解释: JWT 格式的 access token 取值范围: 字符长度1-32768位 |
| agent_id | String | 参数解释: Agent 唯一标识,UUID 格式,通过 POST /v1/agent/auth/token 接口获取 agent_id 后传入 取值范围: 字符长度36位,格式为 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx(8-4-4-4-12 的十六进制字符串) |
| expires_in | Long | 参数解释: Token 有效期(秒) 取值范围: 最小值60,最大值604800(7天) |
请求示例
{
"install_key" : "ik_x9y8z7w6v5u4t3s2r1q0p",
"host_ip" : "192.168.1.100",
"hostname" : "DESKTOP-ABC123",
"mac_address" : "00:1A:2B:3C:4D:5E",
"gateway_port" : 8080,
"gateway_mode" : "local",
"gateway_bind" : "127.0.0.1",
"container_id" : "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
"cluster_id" : "cluster-01abc",
"namespace_id" : "ns-default",
"pod_id" : "pod-abc123"
} 响应示例
状态码:201
{
"access_token" : "eyJhbGciOiJIUzI1NiJ9.eyJyb2xlIjoiYWdlbnQiLCJpZCI6IjI0NGE5Y2YxLWJiYzctM2M1Ny04NDRhLTJmMjdmNTEzYTM0MCIsInN1YiI6Imh0dHAtdG9rZW4iLCJpc3MiOiJtYXN0ZXIiLCJpYXQiOjE3ODc5MDAyODksImV4cCI6MTc4Nzk4NjY5MH0.V4JHNED7k8d1ogKw4Mh9Fs1ZmWdOENFG1HXO5gIfh_0",
"agent_id" : "244a9cf1-bbc7-3c57-844a-2f27f513a340",
"expires_in" : 86400
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 请求已成功 |
错误码
请参见错误码。