DsgDesensPlanQueryList - - Centro de documentación de Alibaba Cloud

Consulta una lista de reglas de enmascaramiento de datos en Data Security Guard.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DsgDesensPlanQueryList	La operación que desea ejecutar. Establezca el valor en DsgDesensPlanQueryList.
PageNumber	Integer	Sí	1	El número de página.
PageSize	Integer	Sí	10	El número de entradas por página. El máximo es 100.
SceneId	Integer	Sí	123	El ID del escenario de enmascaramiento de datos de nivel 2. Llame a la operación DsgSceneQuerySceneListByName para consultar la lista de ID.
RuleName	String	No	phone	El nombre del campo sensible.
Owner	String	No	user1	El propietario de la regla de enmascaramiento de datos.
Status	Integer	No	1	El estado de la regla de enmascaramiento de datos. Valores válidos: 0: caducado 1: vigente

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Success	Boolean	true	Indica si la solicitud se realizó correctamente. Valores válidos: true false
ErrorCode	String	1029030003	El código de error.
ErrorMessage	String	param error	El mensaje de error.
HttpStatusCode	Integer	400	El código de estado HTTP.
PageData	Object		La información de paginación.
PageNumber	Integer	1	El número de página.
PageSize	Integer	10	El número de entradas por página. El máximo es 100.
TotalCount	Integer	100	El número de reglas de enmascaramiento de datos.
Data	Array of Datas		La información sobre la regla de enmascaramiento de datos.
Id	Long	123	El ID de la regla de enmascaramiento de datos.
DataType	String	phone	El tipo de campo sensible.
RuleName	String	phone_hash	El nombre de la regla de enmascaramiento de datos.
DesensPlan	Object		Los detalles de la regla de enmascaramiento de datos.
DesensPlanType	String	hash	El tipo de la regla de enmascaramiento de datos.
ExtParam	Map		Los parámetros de la regla de enmascaramiento de datos. Para obtener más información sobre los parámetros, consulte la referencia de la API DsgDesensPlanAddOrUpdate.
	Any	"extParam": { "algo":"MD5", "salt":"5" }	Los detalles de los parámetros de la regla de enmascaramiento de datos.
Owner	String	user1	El propietario de la regla de enmascaramiento de datos.
GmtCreate	String	2024-05-09 15:46:20	La hora en que se creó la regla de enmascaramiento de datos.
GmtModified	String	2024-05-09 15:46:20	La hora en que se modificó la regla de enmascaramiento de datos.
Status	Integer	1	El estado de la regla de enmascaramiento de datos. Valores válidos: 0: caducado 1: vigente
DesensWay	String	HASH	El método de enmascaramiento de datos.
DesenMode	String	HASH	El tipo del método de enmascaramiento de datos.
DesensRule	String	HASH	La regla de enmascaramiento de datos.
SceneCode	String	dataworks_display_desense_code	El código del escenario de enmascaramiento de datos de nivel 1 al que pertenece la regla. Valores válidos: dataworks_display_desense_code: enmascaramiento de datos mostrados en DataStudio y Data Map maxcompute_desense_code: enmascaramiento de datos en la capa del motor de cómputo de MaxCompute maxcompute_new_desense_code: enmascaramiento de datos en la capa del motor de cómputo de MaxCompute (nuevo) hologres_display_desense_code: enmascaramiento de datos en la capa del motor de cómputo de Hologres dataworks_data_integration_desense_code: enmascaramiento estático de datos en Data Integration dataworks_analysis_desense_code: enmascaramiento de datos mostrados en DataAnalysis
CheckWatermark	Boolean	true	Indica si se agregó una marca de agua. Valores válidos: true false
SceneName	String	test_scene	El nombre del escenario de enmascaramiento de datos de nivel 2 al que pertenece la regla.
RequestId	String	102400001	El ID de la solicitud. Use este ID para localizar registros y solucionar problemas.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=DsgDesensPlanQueryList
&PageNumber=1
&PageSize=10
&SceneId=123
&RuleName=phone
&Owner=user1
&Status=1
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato 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>

Formato 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"
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	El tipo de campo sensible ya se especificó en la regla de enmascaramiento de datos.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	El tipo de campo sensible no existe.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	El ID de la regla de enmascaramiento de datos no existe.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	El número de entradas por página supera el límite superior. El máximo es 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	Los valores especificados para uno o más parámetros de la regla de enmascaramiento de datos no son válidos.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	El código del escenario no existe.
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	El ID del escenario no existe.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	El escenario de enmascaramiento de datos no es un escenario de nivel 2.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	El número de reglas de enmascaramiento de datos supera el límite superior.
400	PARAMS.ERROR	param error.	Los valores especificados para uno o más parámetros no son válidos.
403	PERMISSION.DENIED.ERROR	Permission denied	No tiene permiso para realizar esta operación.
500	UNKNOWN.ERROR	unknown error.	Se produjo un error desconocido.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.