更新时间:2023-09-18 GMT+08:00
分享

设置共享链接

功能介绍

用于添加共享链接。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/connections/share

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户token。

X-Language

String

语言。

表3 请求Body参数

参数

是否必选

参数类型

描述

shared_conn_id

String

共享连接ID。

expired_time

String

过期时间。

users

Array of ShareConnUserInfo objects

用户。

表4 ShareConnUserInfo

参数

是否必选

参数类型

描述

user_id

String

用户ID。

user_name

String

用户名。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:8

最大长度:36

error_msg

String

错误描述。

最小长度:2

最大长度:512

请求示例

设置共享链接。

POST https://{{endpoint}}/v3/{{project_id}}/connections/share 
{ 
  "shared_conn_id": "ee64e597-4f25-486f-bba1-0c850b3b59d6", 
  "users": [ 
    { 
      "user_id": "0852a89ae180d5401f5ac00271a4a02e", 
      "user_name": "username" 
    } 
  ], 
  "expired_time": "2023-05-03T10:30:00.200Z" 
}

响应示例

无。

状态码

状态码

描述

200

Success.

400

BadRequest.

500

InternalServerError.

错误码

请参见错误码

相关文档