Skip to content

连接云机 ​

获取云机连接配置信息。

接口地址:

text
/papi/container/operate/getConnectConfig

请求方式:

text
POST

请求数据类型:

text
application/json

Header 参数:

参数类型必填说明
X-Access-Keystring是API 访问密钥 ID,鉴权方式见 接口规则
X-Signaturestring是签名值,Base64 编码的 HMAC-SHA256 计算结果
X-Timestampstring是毫秒级 Unix 时间戳(13 位)
X-Noncestring是随机字符串,10~32 位小写字母+数字

Body 参数:

参数类型必填说明
ctrAliasstring是容器别名

请求示例:

json
{
  "ctrAlias": "22d6sr1gii"
}

响应参数:

参数类型说明
codeinteger错误码,参见 错误码说明
dataBaseWebSocketConnectVO返回数据
├─ aliasstring别名
├─ signalServerUrlstring信令服务器 URL
├─ spareSignalstring备用信令
├─ roomIdstring房间 ID
├─ turnServerUristringTURN 服务器 URI
├─ isControlboolean是否控制
├─ tokenstring认证令牌
├─ hostTurnarray[string]主中继
├─ spareTurnarray[string]备用中继
├─ expiresinteger过期时间
msgstring错误提示

响应示例:

json
{
  "code": 0,
  "data": {
    "alias": "",
    "signalServerUrl": "",
    "spareSignal": "",
    "roomId": "",
    "turnServerUri": "",
    "isControl": false,
    "token": "",
    "hostTurn": [""],
    "spareTurn": [""],
    "expires": 0
  },
  "msg": ""
}

OpenAPI Docs