调用DescribeWhitelist查询实人认证的白名单规则。

该接口的QPS上限为10。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeWhitelist

要执行的操作。取值：DescribeWhitelist。

CurrentPage Integer 是 1

当前页码，默认值为1。
PageSize Integer 是 20

要查询的白名单规则的数据量。默认返回20条数据。取值范围：0~100。
BizType String 否 RPBasicTest

要查询的实人认证业务场景标识。请先参见业务设置在控制台完成创建。

BizId String 否 aaaeeee160569361xxxx

要查询的认证任务的唯一ID，不超过64字符。

说明 发起不同的认证任务时需要更换不同的BizId。
IdCardNum String 否 34xxxxxxxxxxxxxxxx

白名单用户的身份证号码。
ValidStartDate String 否 1619798400000

有效期开始时间，使用时间戳格式，单位为毫秒。
ValidEndDate String 否 1620748800000

有效期结束时间，使用时间戳格式，单位为毫秒。
Valid String 否 1

白名单规则是否有效。取值：

  • 0：表示无效。
  • 1：表示有效。

返回数据

名称 类型 示例值 描述
CurrentPage Integer 1

当前页码。
Items Array of Item

返回的白名单列表。
BizId String aaaeeee160569361xxxx

认证ID。
BizType String RPBasicTest

业务场景标识。
EndDate Long 1621046699000

有效期结束时间，使用时间戳格式，单位为毫秒。
GmtCreate Long 1621046699000

用户加入白名单的时间，使用时间戳格式，单位为毫秒。
GmtModified Long 1621046699000

修改用户加入白名单的时间，使用时间戳格式，单位为毫秒。
Id Long 1

您创建的白名单规则ID。您在调用DeleteWhitelist从白名单中移除指定用户时，必须提供对应的白名单规则ID。

IdCardNum String *****************3

脱敏后的身份证号。
StartDate Long 1621046699000

有效期开始时间，使用时间戳格式，单位为毫秒。
Uid Long 1621046699

您的阿里云账号ID或者RAM用户ID。
Valid Integer 1

白名单规则是否有效。取值：

  • 0：表示无效。
  • 1：表示有效。
PageSize Integer 20

当前页面显示结果的最大数量。
RequestId String 130A2C10-B9EE-4D84-88E3-5384FF039795

本次请求的ID。
TotalCount Integer 10

查询结果的总数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeWhitelist
&CurrentPage=1
&PageSize=20
&<公共请求参数>

正常返回示例

XML格式 

<DescribeWhitelistResponse>
	  <TotalCount>10</TotalCount>
	  <PageSize>20</PageSize>
	  <RequestId>130A2C10-B9EE-4D84-88E3-5384FF039795</RequestId>
	  <CurrentPage>1</CurrentPage>
	  <Items>
		    <StartDate>1621046699000</StartDate>
		    <Uid></Uid>
		    <GmtCreate>1621046699000</GmtCreate>
		    <Valid>1</Valid>
		    <GmtModified>1621046699000</GmtModified>
		    <BizType>RPBasicTest</BizType>
		    <Id>1</Id>
		    <BizId>1</BizId>
		    <EndDate>1621046699000</EndDate>
		    <IdCardNum>*****************3</IdCardNum>
	  </Items>
  </DescribeWhitelistResponse>

JSON格式 

{
	"TotalCount": "10",
	"PageSize": "20",
	"RequestId": "130A2C10-B9EE-4D84-88E3-5384FF039795",
	"CurrentPage": "1",
	"Items": [{
		"StartDate": "1621046699000",
		"Uid": "",
		"GmtCreate": "1621046699000",
		"Valid": "1",
		"GmtModified": "1621046699000",
		"BizType": "RPBasicTest",
		"Id": "1",
		"BizId": "1",
		"EndDate": "1621046699000",
		"IdCardNum": "*****************3"
	}]
}

错误码

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