天羽蜂开放接口文档

天羽蜂算立方产品说明

天羽蜂智能算网平台 API 接口

容器 API

1. 获取平台验证 token 接口

POST 请求

请求 url： http://112.112.112.4/user/token

入参列表：

字段名 变量名 类型 说明
用户 ID clientId String 必填，作为身份识别
用户密钥 clientSecret String 必填，用于身份验证 
 入参示例
 {
 "clientId": "01912592-bcxv-7bee-a6d8-60207f37c8d5",
 "clientSecret":"ksjd8q3hkdnsxvxchj5d8a2cxks"
 }

出参列表：

字段名 变量名 类型 说明
状态码 status Number 响应状态
提示信息 msg String 例如过期 ExpiredSignature
标识 token String 用于后续的接口验证,替换后文中的[my_token] 
出参示例:


 // 成功
 {
 "status": 200,
 "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOxcvxkxMjU5Mi0xMThmLTdiZWUtYTZkOC02MDIwN2YzN2M4ZDUiLCJpYXQiOjE3MjI5MTQzMzIsImV4cCI6MTcyMjkyODczMn0.LFr00Dnb669o8zPrxWFmr5_pKHj8zSSDHh9tt91VjmA"
 }
 // 失败
 {
 "status": 500,
 "msg": "ExpiredSignature"
 }

2. 容器创建接口

POST 请求

请求 url： http://112.112.112.4/api/app/create

请求头 Authorization 添加 Bearer [my_token]

入参列表：

字段名 变量名 类型 说明
应用 ID id String 必填，唯一
镜像名 source String 必填，已上传至镜像库中的镜像名
标签 branch String 必填，该镜像对应的标签
环境变量 envVars Object 必填，格式[{“key”:”my_key”,”value”:”my_val”}],为空传入[]空数组
容器内端口 innerPort Number 必填，应用容器内监听端口
物理机挂载卷 outerVolume String 选填
容器挂载卷 innerVolume String 选填 
入参示例:

 {
 "id": "user_app_id",
 "source":"nats",
 "branch":"latest",
 "envVars":[{"key":"my_key1","value":"my_val1"},
{"key":"my_key2", "value":"my_val2"}],
 "innerPort":4222
 }

出参列表：

字段名 变量名 类型 说明
状态码 status Number 响应状态
提示信息 msg String 例如请求报错内容
应用 ID id String  
镜像名 source String  
标签 branch String  
环境变量 envVars Object  
容器内端口 innerPort Number  
物理机端口 httpPort Number  
物理机挂载卷 outerVolume String  
容器挂载卷 innerVolume String  
公网 IP httpHost String  
内网 IP vpcHost String 内网应用使用此 IP 地址
创建时间 createdAt Number   
出参示例:


// 成功
{
"status": 200,
"id": "user_app_id",
"source": "nats",
"branch": "latest",
"envVars": [
{
"key": "my_key1",
"value": "my_val2"
},
{
"key": "my_key2",
"value": "my_val2"
}
],
"innerPort": 4222,
"httpPort": 50453,
"innerVolume": **null**,
"outerVolume": **null,**
"httpHost": "218.88.202.70",
"vpcHost": "112.112.112.6",
"createdAt": 1722917410946
}

// 失败
{
"status": 500,
"msg": "Server Interner Error"
}

3.容器销毁接口

POST 请求

请求 url： http://112.112.112.4/api/app/destroy

请求头 Authorization 添加 Bearer [my_token]

入参列表：

字段名 变量名 类型 说明
应用 ID id String 必填，唯一 
入参示例
{
"id": "user_app_id"
}

出参列表：

字段名 变量名 类型 说明
状态码 status Number 响应状态
提示信息 msg String 例如请求报错内容 
出参示例

// 成功
{
"status": 200
}

// 失败
{
"status": 500,
"msg": "Query returned no rows"
}

4.容器启动接口

POST 请求

请求 url： http://112.112.112.4/api/app/start

请求头 Authorization 添加 Bearer [my_token]

入参列表：

字段名 变量名 类型 说明
应用 ID id String 必填，唯一 
入参示例
{
"id": "user_app_id"
}

出参列表：

字段名 变量名 类型 说明
状态码 status Number 响应状态
提示信息 msg String 例如请求报错内容 
出参示例

// 成功
{
"status": 200
}

// 失败
{
"status": 500,
"msg": "Query returned no rows"
}

5.容器停止接口

POST 请求

请求 url： http://112.112.112.4/api/app/stop

请求头 Authorization 添加 Bearer [my_token]

入参列表：

字段名 变量名 类型 说明
应用 ID id String 必填，唯一 
入参示例
{
"id": "user_app_id"
}

出参列表：

字段名 变量名 类型 说明
状态码 status Number 响应状态
提示信息 msg String 例如请求报错内容 
出参示例

// 成功
{
"status": 200
}

// 失败
{
"status": 500,
"msg": "Query returned no rows"
}
回到首页