調用DsgWhiteListQueryList介面,查詢資料保護傘中配置的脫敏白名單。
調試
您可以在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 | 調用是否成功。取值如下:
|
| 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. | 未知錯誤。 |
訪問錯誤中心查看更多錯誤碼。