Setting a Shared Connection

Function

This API is used to add a shared connection.

URI

POST /v3/{project_id}/connections/share

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
shared_conn_id	Yes	String	Explanation: ID of a shared connection established between a database account and the database. The database user ID is created using the API in Creating an Instance Connection. Constraints: N/A Values: The value is a UUID containing 36 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A
expired_time	No	String	Explanation: Expiration time Constraints: Format: yyyy-MM-ddTHH:mm:ss.SSSZ Values: N/A Default value: N/A
users	Yes	Array of ShareConnUserInfo objects	Explanation: User Constraints: Multiple values need to be separated by commas (,). Values: N/A Default value: N/A

**Table 3** ShareConnUserInfo
Parameter	Mandatory	Type	Description
user_id	Yes	String	Explanation: User ID Constraints: N/A Values: N/A Default value: N/A
user_name	Yes	String	Explanation: Username Constraints: N/A Values: N/A Default value: N/A

Response Parameters

Status code: 200

None

Example Request

Setting a shared link

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" 
}