Updated on 2024-07-30 GMT+08:00

Stopping Sharing Files

Function

Stop sharing files.

URI

POST /koodrive/ose/v1/share/cancel

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}.

X-Traceid

No

String

Service trace ID, which contains 58 bits.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

shareIds

No

Array of strings

List of IDs of files whose sharing is to be stopped.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response information.

subResponseList

Array of ShareSubResponse objects

Sub-response list.

Table 4 ShareSubResponse

Parameter

Type

Description

shareId

String

Sharing ID.

code

String

Sub-response code.

message

String

Sub-response message.

Example Requests

POST /koodrive/ose/v1/share/cancel

{
  "shareIds" : [ "string" ]
}

Example Responses

Status code: 200

OK

{
  "code" : "string",
  "msg" : "string",
  "subResponseList" : [ {
    "shareId" : "string",
    "code" : "string",
    "message" : "string"
  } ]
}

Status Codes

Status Code

Description

200

OK