Help Center/KooDrive/API Reference（Carrier）/API/Carrier Calling APIs/Obtaining the Retention Period Policy Configuration List
Updated on 2026-02-12 GMT+08:00
View PDF
Share

Obtaining the Retention Period Policy Configuration List

Function

Obtain the retention period policy configuration list.

URI

GET /koodrive/ose/v1/carrier/policy/config/retention

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

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

policyList

Array of CarrierRetentionPolicy objects

Policy list.

Table 3 CarrierRetentionPolicy

Parameter

Type

Description

policyId

Integer

Policy ID.

policyName

String

Policy name.

description

String

Policy description.

priority

Integer

Priority. A larger value indicates a higher priority. The default value is 10.

Example Requests

/koodrive/ose/v1/carrier/policy/config/retention

Example Responses

Status code: 200

Response to the request for viewing a retention period policy.

{
  "policyList" : [ {
    "policyId" : 300000000000000000,
    "policyName" : "downgrade_free",
    "description" : "Downgrade to free package.",
    "priority" : 3
  }, {
    "policyId" : 300000000000000000,
    "policyName" : "delete_unused_user",
    "description" : "0: Delete a user.",
    "priority" : 5
  }, {
    "policyId" : 300000000000000000,
    "policyName" : "RetentionPolicy",
    "description" : "Retention period policy.",
    "priority" : 2
  } ],
  "code" : 0,
  "msg" : "success"
}

Status Codes

Status Code

Description

200

Response to the request for viewing a retention period policy.