DsgWhiteListQueryList-阿里云帮助中心_(DataWorks)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DsgWhiteListQueryList	系统规定参数。取值：DsgWhiteListQueryList。
PageNumber	Integer	是	1	分页的页数。
PageSize	Integer	是	10	每页显示的条数，最大100条。
SceneId	Long	是	123	二级脱敏场景ID。您可调用DsgSceneQuerySceneListByName接口获取。
DataType	String	否	phone	敏感字段类型的关键字。

返回数据

名称	类型	示例值	描述
Success	Boolean	true	调用是否成功。取值如下： true：调用成功。 false：调用失败。
ErrorCode	String	1029030003	错误码。
ErrorMessage	String	param error	错误信息。
HttpStatusCode	Integer	400	HTTP状态码。
PageData	Object		分页数据。
PageNumber	Integer	1	分页的页数。
PageSize	Integer	10	每页显示的条数。
TotalCount	Integer	100	返回的脱敏白名单总条数。
Data	Array of Datas		白名单集合。
Id	Long	123	脱敏白名单ID。
Type	String	phone	敏感字段类型。
UserGroups	Array of String	test_group	用户组名称。
GmtCreate	String	2024-05-09 15:46:20	脱敏白名单的创建时间。
GmtModified	String	2024-05-09 15:46:20	脱敏白名单的修改时间。
RuleId	Long	123	脱敏规则ID。
SceneId	Long	123	二级脱敏场景ID。
StartTime	String	2024-05-09 15:46:20	脱敏白名单的生效时间，不能早于当前时间。单位为天。
EndTime	String	2024-05-10 15:46:20	脱敏白名单的失效时间，不能早于生效时间。单位为天。
RequestId	String	102400001	请求的ID。用于定位日志，排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=DsgWhiteListQueryList
&PageNumber=1
&PageSize=10
&SceneId=123
&DataType=phone
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgWhiteListQueryListResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <PageData>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <Data>
            <Id>123</Id>
            <Type>phone</Type>
            <UserGroups>test_group</UserGroups>
            <GmtCreate>2024-05-09 15:46:20</GmtCreate>
            <GmtModified>2024-05-09 15:46:20</GmtModified>
            <RuleId>123</RuleId>
            <SceneId>123</SceneId>
            <StartTime>2024-05-09 15:46:20</StartTime>
            <EndTime>2024-05-10 15:46:20</EndTime>
        </Data>
    </PageData>
    <RequestId>102400001</RequestId>
</DsgWhiteListQueryListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "ErrorCode" : "1029030003",
  "ErrorMessage" : "param error",
  "HttpStatusCode" : 400,
  "PageData" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "Data" : [ {
      "Id" : 123,
      "Type" : "phone",
      "UserGroups" : [ "test_group" ],
      "GmtCreate" : "2024-05-09 15:46:20",
      "GmtModified" : "2024-05-09 15:46:20",
      "RuleId" : 123,
      "SceneId" : 123,
      "StartTime" : "2024-05-09 15:46:20",
      "EndTime" : "2024-05-10 15:46:20"
    } ]
  },
  "RequestId" : "102400001"
}

错误码

HttpCode	错误码	错误信息	描述
400	WHITELIST.DESENSID.ERROR	The desensitization rule ID does not match or does not exist with the tenant.	场景ID不存在或不属于该租户。
400	WHITELIST.ENDTIME.ERROR	end time cannot be earlier than start time.	结束时间不能早于开始时间。
400	WHITELIST.ID.ERROR	The whitelist ID does not match or does not exist with the tenant.	白名单ID不存在或不属于该租户。
400	WHITELIST.MCPROJECT.ERROR	The projectName on the bottom layer desensitization whitelist of MC cannot be empty.	ProjectName在创建MaxCompute脱敏白名单时不能为空。
400	WHITELIST.PAGESIZE.ERROR	Page size is too large, maximum of 100.	页大小超限，不能超过100。
400	WHITELIST.SIZE.ERROR	The number of white list exceeds the limit.	白名单数量超限。
400	WHITELIST.STARTTIME.ERROR	start time cannot be earlier than today.	开始时间不能早于今天。
400	WHITELIST.TIMEFORMAT.ERROR	The time format is incorrect, please use yyyy MM dd HH: mm: ss format.	时间参数格式化错误，需使用yyyy MM dd HH: mm: ss。
400	WHITELIST.USERGROUP.ERROR	The user group ID does not match or does not exist with the tenant.	用户组ID不存在或不属于该租户。
400	WHITELIST.USERGROUPEMPTY.ERROR	User group ID cannot be empty.	用户组ID不能为空。
400	WHITELIST.USERGROUPLISTSIZE.ERROR	The number of user group exceeds the limit.	用户组数量超限。
400	PARAMS.ERROR	param error.	参数错误。
403	PERMISSION.DENIED.ERROR	Permission denied	权限不足。
500	UNKNOWN.ERROR	unknown error.	未知错误。

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