ListCustomPrivacyPolicies - 查询自定义条款列表

自定义条款列表查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

查询凭证(Token)。

NTxxxxxexample

PreviousToken

string

查询上一页凭证(Token)。

PTxxxxxexample

MaxResults

integer

分页查询时每页行数。

20

CustomPrivacyPolicyNameStartsWith

string

自定义条款名称,左模糊匹配。

Custom

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

列表总条数目。

100

NextToken

string

本次调用返回的查询凭证(Token)值。

NTxxxexample

PreviousToken

string

本次调用返回的查询凭证(Token)值。

PTxxxexample

MaxResults

integer

分页查询时每页行数。

20

CustomPrivacyPolicies

array<object>

自定义条款列表。

object

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CustomPrivacyPolicyId

string

自定义条款 Id

pp_xxxxx

CustomPrivacyPolicyName

string

自定义条款名称

Custom Privacy Policy Name

Status

string

自定义条款状态

枚举值:

  • disabled :

    禁用

  • enabled :

    启用

enabled

UserConsentType

string

自定义条款同意类型

枚举值:

  • explicit_consent :

    手动勾选同意

  • implied_consent :

    默认同意

implied_consent

DefaultLanguageCode

string

默认语言条款项。具体的值来自 ListLanguages 接口的返回值 LanguageCode。

zh-Hans-CN

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "PreviousToken": "PTxxxexample",
  "MaxResults": 20,
  "CustomPrivacyPolicies": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CustomPrivacyPolicyId": "pp_xxxxx",
      "CustomPrivacyPolicyName": "Custom Privacy Policy Name",
      "Status": "enabled",
      "UserConsentType": "implied_consent",
      "DefaultLanguageCode": "zh-Hans-CN"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情