设置共享链接 - SetSharedConnection
功能介绍
用于添加共享链接。
调试
您可以在API Explorer中调试该接口。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
das:connection:createShareConnections
write
connection
das:TargetOrgPath
das:TargetOrgId
das:TargetAccountId
-
-
URI
POST /v3/{project_id}/connections/share
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
shared_conn_id |
是 |
String |
参数解释： 共享连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接接口创建）。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。 默认取值： 不涉及 |
|
expired_time |
否 |
String |
参数解释： 过期时间。 约束限制： 格式为：yyyy-MM-ddTHH:mm:ss.SSSZ 取值范围： 不涉及。 默认取值： 不涉及。 |
|
users |
是 |
Array of ShareConnUserInfo objects |
参数解释： 用户。 约束限制： 可组合，用逗号分隔。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码： 200
无。
请求示例
设置共享链接。
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. |
错误码
请参见错误码。
