Help Center/KooDrive/API Reference(Carrier)/API/Carrier Calling APIs/Setting a Carrier Retention Period Policy
Updated on 2026-02-12 GMT+08:00

Setting a Carrier Retention Period Policy

Function

Set a new carrier retention period policy.

URI

POST /koodrive/ose/v1/carrier/retention/policy/batch

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

Definition:

This field stores the 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.

Constraints:

The format is bearer+access token.

Range:

For details about how to obtain an access token, see the corresponding developer guide.

Default Value:

N/A

X-Date

Yes

String

Definition:

Signature time, which is used for app ID authentication.

Constraints:

The time must be within 15 minutes from the current time and cannot be later than the current time.

Range:

The format is yyyMMdd'T'HHmmss'Z', for example, 20251103T070140Z.

Default Value:

N/A

X-User-Id

Yes

String

Definition:

User ID on KooDrive, which is used for app ID authentication.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

x-traceid

No

String

Definition:

Service trace ID, which contains 58 bits.

Constraints:

N/A

Range:

The value contains 58 bits.

Default Value:

N/A

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

policyList

Yes

Array of BaseRetentionPolicy objects

Retention period policy list. The maximum length is 50.

Table 3 BaseRetentionPolicy

Parameter

Mandatory

Type

Description

policyId

Yes

String

Policy ID.

status

Yes

String

Status.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Status code.

msg

String

Status description.

Example Requests

Example request for setting a retention period policy.

/koodrive/ose/v1/carrier/retention/policy/batch

{
  "policyList" : [ {
    "policyId" : "300000000000000002",
    "status" : 1
  } ]
}

Example Responses

Status code: 200

Response to the request for setting a retention period policy.

{
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response to the request for setting a retention period policy.