DsgDesensPlanQueryList -

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DsgDesensPlanQueryList	系統規定參數。取值：DsgDesensPlanQueryList。
PageNumber	Integer	是	1	分頁的頁數。
PageSize	Integer	是	10	每頁顯示的資料條數，最大為100。
SceneId	Integer	是	123	二級脫敏情境ID。您可調用DsgSceneQuerySceneListByName介面擷取。
RuleName	String	否	phone	敏感欄位名稱。
Owner	String	否	user1	脫敏規則的負責人。
Status	Integer	否	1	脫敏規則的生效狀態。取值如下： 0：失效。 1：生效。

返回資料

名稱	類型	樣本值	描述
Success	Boolean	true	調用是否成功。取值如下： true：調用成功。 false：調用失敗。
ErrorCode	String	1029030003	錯誤碼。
ErrorMessage	String	param error	錯誤資訊。
HttpStatusCode	Integer	400	HTTP狀態代碼。
PageData	Object		分頁資料。
PageNumber	Integer	1	頁碼。
PageSize	Integer	10	每頁顯示的資料條數，最大為100。
TotalCount	Integer	100	返回的脫敏規則條數。
Data	Array of Datas		脫敏規則資訊。
Id	Long	123	脫敏規則ID。
DataType	String	phone	敏感欄位類型。
RuleName	String	phone_hash	脫敏規則名稱。
DesensPlan	Object		脫敏規則詳情。
DesensPlanType	String	hash	脫敏規則類型。
ExtParam	Map		脫敏規則參數。參數資訊可參考DsgDesensPlanAddOrUpdate介面文檔。
	Any	"extParam": { "algo":"MD5", "salt":"5" }	脫敏規則參數詳情。
Owner	String	user1	脫敏規則的負責人。
GmtCreate	String	2024-05-09 15:46:20	脫敏規則的建立時間。
GmtModified	String	2024-05-09 15:46:20	脫敏規則的修改時間。
Status	Integer	1	脫敏規則的生效狀態。取值如下： 0：失效。 1：生效。
DesensWay	String	HASH	脫敏方式。
DesenMode	String	HASH	脫敏方式類型。
DesensRule	String	HASH	脫敏規則。
SceneCode	String	dataworks_display_desense_code	脫敏規則所屬的一級脫敏情境Code。取值如下：資料開發/資料地圖展示脫敏：dataworks_display_desense_code MaxCompute引擎層脫敏：maxcompute_desense_code MaxCompute引擎層脫敏（新）：maxcompute_new_desense_code Hologres引擎層脫敏：hologres_display_desense_code Data Integration靜態脫敏：dataworks_data_integration_desense_code 資料分析展示脫敏：dataworks_analysis_desense_code
CheckWatermark	Boolean	true	是否添加浮水印。取值如下： true：添加。 false：不添加。
SceneName	String	test_scene	脫敏規則所屬的二級脫敏情境名稱。
RequestId	String	102400001	請求的ID。用於定位日誌，排查問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DsgDesensPlanQueryList
&PageNumber=1
&PageSize=10
&SceneId=123
&RuleName=phone
&Owner=user1
&Status=1
&公用請求參數

正常返回樣本

XML格式

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

<DsgDesensPlanQueryListResponse>
    <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>
            <DataType>phone</DataType>
            <RuleName>phone_hash</RuleName>
            <DesensPlan>
                <DesensPlanType>hash</DesensPlanType>
                <ExtParam>
                    <key>"extParam": {             "algo":"MD5",             "salt":"5"           }</key>
                </ExtParam>
            </DesensPlan>
            <Owner>user1</Owner>
            <GmtCreate>2024-05-09 15:46:20</GmtCreate>
            <GmtModified>2024-05-09 15:46:20</GmtModified>
            <Status>1</Status>
            <DesensWay>HASH</DesensWay>
            <DesenMode>HASH</DesenMode>
            <DesensRule>HASH</DesensRule>
            <SceneCode>dataworks_display_desense_code</SceneCode>
            <CheckWatermark>true</CheckWatermark>
            <SceneName>test_scene</SceneName>
        </Data>
    </PageData>
    <RequestId>102400001</RequestId>
</DsgDesensPlanQueryListResponse>

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,
      "DataType" : "phone",
      "RuleName" : "phone_hash",
      "DesensPlan" : {
        "DesensPlanType" : "hash",
        "ExtParam" : {
          "key" : "\"extParam\": {             \"algo\":\"MD5\",             \"salt\":\"5\"           }"
        }
      },
      "Owner" : "user1",
      "GmtCreate" : "2024-05-09 15:46:20",
      "GmtModified" : "2024-05-09 15:46:20",
      "Status" : 1,
      "DesensWay" : "HASH",
      "DesenMode" : "HASH",
      "DesensRule" : "HASH",
      "SceneCode" : "dataworks_display_desense_code",
      "CheckWatermark" : true,
      "SceneName" : "test_scene"
    } ]
  },
  "RequestId" : "102400001"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	敏感類型已經配置脫敏規則。
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	敏感類型不存在。
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	脫敏規則ID不存在。
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	頁大小超限，最大為100。
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	歐敏規則參數錯誤。
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	情境碼不存在。
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	情境ID不存在。
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	情境不是二級情境。
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	脫敏規則數量超限。
400	PARAMS.ERROR	param error.	參數錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。

訪問錯誤中心查看更多錯誤碼。