DsgDesensPlanQueryList - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DsgDesensPlanQueryList	Operação a ser executada. Defina o valor como DsgDesensPlanQueryList.
PageNumber	Integer	Sim	1	Número da página.
PageSize	Integer	Sim	10	Quantidade de entradas por página. O limite máximo é 100.
SceneId	Integer	Sim	123	ID do cenário de mascaramento de dados de nível 2. Chame a operação DsgSceneQuerySceneListByName para consultar a lista de IDs.
RuleName	String	Não	phone	Nome do campo sensível.
Owner	String	Não	user1	Proprietário da regra de mascaramento de dados.
Status	Integer	Não	1	Status da regra de mascaramento de dados. Valores válidos: 0: expirado 1: vigente

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
ErrorCode	String	1029030003	Código de erro.
ErrorMessage	String	param error	Mensagem de erro.
HttpStatusCode	Integer	400	Código de status HTTP.
PageData	Object		Informações de paginação.
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Quantidade de entradas por página. O limite máximo é 100.
TotalCount	Integer	100	Total de regras de mascaramento de dados.
Data	Array of Datas		Informações da regra de mascaramento de dados.
Id	Long	123	ID da regra de mascaramento de dados.
DataType	String	phone	Tipo do campo sensível.
RuleName	String	phone_hash	Nome da regra de mascaramento de dados.
DesensPlan	Object		Detalhes da regra de mascaramento de dados.
DesensPlanType	String	hash	Tipo da regra de mascaramento de dados.
ExtParam	Map		Parâmetros da regra de mascaramento de dados. Para mais informações, consulte a referência da API DsgDesensPlanAddOrUpdate.
	Any	"extParam": { "algo":"MD5", "salt":"5" }	Detalhes dos parâmetros da regra de mascaramento de dados.
Owner	String	user1	Proprietário da regra de mascaramento de dados.
GmtCreate	String	2024-05-09 15:46:20	Data e hora de criação da regra de mascaramento de dados.
GmtModified	String	2024-05-09 15:46:20	Data e hora da última modificação da regra de mascaramento de dados.
Status	Integer	1	Status da regra de mascaramento de dados. Valores válidos: 0: expirado 1: vigente
DesensWay	String	HASH	Método de mascaramento de dados.
DesenMode	String	HASH	Tipo do método de mascaramento de dados.
DesensRule	String	HASH	Regra de mascaramento de dados.
SceneCode	String	dataworks_display_desense_code	Código do cenário de mascaramento de dados de nível 1 ao qual a regra pertence. Valores válidos: dataworks_display_desense_code: mascaramento de dados exibidos no DataStudio e no Data Map maxcompute_desense_code: mascaramento de dados na camada do mecanismo de computação do MaxCompute maxcompute_new_desense_code: mascaramento de dados na camada do mecanismo de computação do MaxCompute (novo) hologres_display_desense_code: mascaramento de dados na camada do mecanismo de computação do Hologres dataworks_data_integration_desense_code: mascaramento estático de dados no Data Integration dataworks_analysis_desense_code: mascaramento de dados exibidos no DataAnalysis
CheckWatermark	Boolean	true	Indica se há marca d'água adicionada. Valores válidos: true false
SceneName	String	test_scene	Nome do cenário de mascaramento de dados de nível 2 ao qual a regra pertence.
RequestId	String	102400001	ID da solicitação. Utilize este ID para localizar logs e solucionar problemas.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	O tipo de campo sensível já possui uma regra de mascaramento de dados definida.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	O tipo de campo sensível não existe.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	O ID da regra de mascaramento de dados não existe.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	O número de entradas por página excede o limite superior. O máximo permitido é 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	Um ou mais parâmetros da regra de mascaramento de dados são inválidos.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	O código do cenário não existe.
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	O ID do cenário não existe.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	O cenário de mascaramento de dados não é de nível 2.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	A quantidade de regras de mascaramento de dados excede o limite superior.
400	PARAMS.ERROR	param error.	Um ou mais parâmetros especificados são inválidos.
403	PERMISSION.DENIED.ERROR	Permission denied	Você não tem autorização para executar esta operação.
500	UNKNOWN.ERROR	unknown error.	Ocorreu um erro desconhecido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.