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

Chama a API DsgDesensPlanQueryList para consultar as regras de mascaramento de dados do Data Security Guard (DSG).

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 Resource

*

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 a serem retornadas em cada página. O valor máximo é 100.	10
SceneId	integer	Sim	O ID do cenário de desensibilização de dados de nível 2. Você pode chamar a operação DsgSceneQuerySceneListByName para obter este ID.	123
RuleName	string	Não	O nome da regra de desensibilização.	phone
Owner	string	Não	O proprietário da regra de desensibilização.	user1
Status	integer	Não	O status da regra de desensibilização. Valores válidos: 0: Inativo 1: Ativo	1
columns	array<object>	Não
	object	Não
dbType	string	Não
project	string	Não
table	string	Não
column	string	Não
emptyNotDesesn	string	Não
dataType	string	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação 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 paginados.
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 desensibilização correspondentes.	100
Data	array<object>	Os detalhes das regras de desensibilização.
	array<object>	Um único objeto de regra de desensibilização.
Id	integer	The ID of the desensitization rule.	123
DataType	string	The sensitive data type.	phone
RuleName	string	The name of the desensitization rule.	phone_hash
DesensPlan	object	The details of the desensitization plan.
DesensPlanType	string	The type of the desensitization plan.	hash
ExtParam	object	The parameters for the desensitization rule. For details, see the DsgDesensPlanAddOrUpdate operation.
	any	The details of the desensitization rule parameters.	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	The owner of the desensitization rule.	user1
GmtCreate	string	The time when the rule was created.	2024-05-09 15:46:20
GmtModified	string	The time when the rule was last modified.	2024-05-09 15:46:20
Status	integer	The status of the rule. Valid values: 0: Inactive. 1: Active.	1
DesensWay	string	The desensitization method.	HASH
DesenMode	string	The desensitization method.	HASH
DesensRule	string	The desensitization rule.	HASH
SceneCode	string	The level-1 desensitization scene code. Valid values: Desensitization for display in Data Development and Data Map: dataworks_display_desense_code Desensitization at the MaxCompute engine layer: maxcompute_desense_code Desensitization at the MaxCompute engine layer (New): maxcompute_new_desense_code Desensitization at the Hologres engine layer: hologres_display_desense_code Static desensitization in Data Integration: dataworks_data_integration_desense_code Desensitization for display in Data Analysis: dataworks_analysis_desense_code	dataworks_display_desense_code
CheckWatermark	boolean	Indicates whether to add a watermark. Valid values: true: A watermark is added. false: No watermark is added.	true
SceneName	string	The name of the level-2 desensitization scene.	test_scene
emptyNotDesesn	boolean
columns	array<object>
	object
dbType	string
project	string
table	string
column	string
RequestId	string	O ID da solicitação. Você pode usar este 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": "",
            "project": "",
            "table": "",
            "column": ""
          }
        ]
      }
    ]
  },
  "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.	Desensitization rules have been configured for sensitive types.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.	The sensitive type does not exist.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.	The desensitization rule ID does not exist.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.	Page size limit, up to 100
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.	The desensitization rule parameter is incorrect.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.	Scene code does not exist
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.	Scene ID does not exist.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.	The scene is not a secondary scene.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.	The number of desensitization rules exceeded the limit.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.	Unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied	Insufficient permissions.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.