文档首页/ 云空间服务 KooDrive/ API参考（运营商）/ API/ 运营商调用接口/ 获取保留期策略配置列表 - GetCarrierRetentionPolicy
更新时间：2026-04-16 GMT+08:00
查看PDF
分享

获取保留期策略配置列表 - GetCarrierRetentionPolicy

功能介绍

获取保留期策略配置列表

授权信息

当前API调用无需身份策略权限。

URI

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

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

参数解释：

该字段存储的是 Access Token。

调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。

约束限制：

格式参考:Bearer+/access token}

取值范围：

Access Token的获取请参考对应的开发手册

默认取值：

不涉及

X-Date

是

String

参数解释：

签名时间，用于appId鉴权

约束限制：

距当前时间15分钟以内，不能晚于当前时间

取值范围：

yyyMMdd'T'HHmmss'Z'，例：20251103T070140Z

默认取值：

不涉及

X-User-Id

是

String

参数解释：

koodrive侧用户id，用于appId鉴权

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

x-traceid

否

String

参数解释：

业务跟踪id（必须58位）

约束限制：

不涉及

取值范围：

长度为58位

默认值：

不涉及

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

policyList

Array of CarrierRetentionPolicy objects

策略列表
表3 CarrierRetentionPolicy

参数

参数类型

描述

policyId

Integer

策略ID

policyName

String

策略名称

description

String

策略描述

priority

Integer

优先级(数字越大优先级越高)，默认10

请求示例

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

响应示例

状态码：200

查看保留期策略响应

{
  "policyList" : [ {
    "policyId" : 300000000000000000,
    "policyName" : "downgrade_free",
    "description" : "降至免费套餐",
    "priority" : 3
  }, {
    "policyId" : 300000000000000000,
    "policyName" : "delete_unused_user",
    "description" : "0使用删除用户",
    "priority" : 5
  }, {
    "policyId" : 300000000000000000,
    "policyName" : "RetentionPolicy",
    "description" : "保留期策略",
    "priority" : 2
  } ],
  "code" : 0,
  "msg" : "success"
}

状态码

状态码

描述

200

查看保留期策略响应
父主题： 运营商调用接口