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

Consulta as regras de mascaramento de dados no Data Security Guard.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:DsgDesensPlanQueryList

list

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Sim	O número da página.	1
PageSize	integer	Sim	O número de entradas por página. Valor máximo: 100.	10
SceneId	integer	Sim	O ID do cenário de mascaramento de dados de nível 2. Você pode chamar a operação DsgSceneQuerySceneListByName para obter o ID.	123
RuleName	string	Não	O nome do campo sensível.	phone
Owner	string	Não	O proprietário da regra de mascaramento de dados.	user1
Status	integer	Não	O status efetivo da regra de mascaramento de dados. Valores válidos: 0: Inativo. 1: Ativo.	1
columns	array<object>	Não	A lista de colunas associadas ao mascaramento de dados.
	object	Não
dbType	string	Não	O tipo da fonte de dados.	ODPS.ODPS
project	string	Não	O nome do espaço de trabalho.	test_dev
table	string	Não	O nome da tabela.	test_table_dev
column	string	Não	O nome da coluna.	test_col_dev
emptyNotDesesn	string	Não	Especifica se os valores nulos não são mascarados. Valor padrão: false.	true
dataType	string	Não	O tipo de dados sensíveis.	phone

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
ErrorCode	string	O código de erro.	1029030003
ErrorMessage	string	A mensagem de erro.	param error
HttpStatusCode	integer	O código de status HTTP.	400
PageData	object	Os dados de paginação.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página. Valor máximo: 100.	10
TotalCount	integer	O número total de regras de mascaramento de dados retornadas.	100
Data	array<object>	As informações da regra de mascaramento de dados.
	array<object>	As informações da regra de mascaramento de dados.
Id	integer	O ID da regra de mascaramento de dados.	123
DataType	string	O tipo do campo sensível.	phone
RuleName	string	O nome da regra de mascaramento de dados.	phone_hash
DesensPlan	object	Os detalhes da regra de mascaramento de dados.
DesensPlanType	string	O tipo da regra de mascaramento de dados.	hash
ExtParam	object	Os parâmetros da regra de mascaramento de dados. Para obter mais informações sobre os parâmetros, consulte a operação DsgDesensPlanAddOrUpdate.
	any	Os parâmetros detalhados da regra de mascaramento de dados.	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	O proprietário da regra de mascaramento de dados.	user1
GmtCreate	string	A hora em que a regra de mascaramento de dados foi criada.	2024-05-09 15:46:20
GmtModified	string	A hora em que a regra de mascaramento de dados foi atualizada.	2024-05-09 15:46:20
Status	integer	O status efetivo da regra de mascaramento de dados. Valores válidos: 0: Inativo. 1: Ativo.	1
DesensWay	string	O método de mascaramento de dados.	HASH
DesenMode	string	O tipo do método de mascaramento de dados.	HASH
DesensRule	string	A regra de mascaramento de dados.	HASH
SceneCode	string	O código do cenário de mascaramento de dados de nível 1 ao qual a regra de mascaramento de dados pertence. Valores válidos: dataworks_display_desense_code: Mascaramento de dados para exibição no Data Studio e no Data Map. maxcompute_desense_code: Mascaramento de dados na camada do mecanismo MaxCompute. maxcompute_new_desense_code: Mascaramento de dados na camada do mecanismo MaxCompute (novo). hologres_display_desense_code: Mascaramento de dados na camada do mecanismo Hologres. dataworks_data_integration_desense_code: Mascaramento de dados estático para o Data Integration. dataworks_analysis_desense_code: Mascaramento de dados para exibição no Data Analysis.	dataworks_display_desense_code
CheckWatermark	boolean	Especifica se deve ser adicionada uma marca d'água. Valores válidos: true: Adicionada. false: Não adicionada.	true
SceneName	string	O nome do cenário de mascaramento de dados de nível 2 ao qual a regra de mascaramento de dados pertence.	test_scene
emptyNotDesesn	boolean	Especifica se os valores nulos não são mascarados. Valor padrão: false.
columns	array<object>	A lista de colunas associadas ao mascaramento de dados.
	object	A lista de colunas associadas ao mascaramento de dados.
dbType	string	O tipo da fonte de dados.	ODPS.ODPS
project	string	O nome do espaço de trabalho.	test_dev
table	string	O nome da tabela.	test_table_dev
column	string	O nome da coluna.	test_col_dev
RequestId	string	O ID da solicitação. Você pode usar o ID para localizar logs e solucionar problemas.	102400001

Exemplos

Resposta de sucesso

JSON formato

{
  "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",
        "emptyNotDesesn": false,
        "columns": [
          {
            "dbType": "ODPS.ODPS",
            "project": "test_dev",
            "table": "test_table_dev",
            "column": "test_col_dev"
          }
        ]
      }
    ]
  },
  "RequestId": "102400001"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.	Uma regra de mascaramento de dados já foi configurada para o tipo sensível.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	O tipo 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 tamanho da página excede o limite. O valor máximo é 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	O parâmetro da regra de mascaramento de dados é inválido.
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 não é um cenário de nível 2.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	O número de regras de mascaramento de dados excede o limite.
400	PARAMS.ERROR	param error.	O parâmetro é inválido.
500	UNKNOWN.ERROR	unknown error.	Ocorreu um erro desconhecido.
403	PERMISSION.DENIED.ERROR	Permission denied	Você não tem permissões suficientes.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.