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 数据集成静态脱敏：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.	未知错误。

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