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

Consulta os resultados de detecção de dados de tabelas e arquivos.

Descrição da operação

Consulta os resultados de detecção de tabelas e arquivos, permitindo visualizar os resultados de detecção de dados de ativos de uma perspectiva global.

Limite de QPS

O limite de QPS por usuário para esta operação é de 10 chamadas por segundo. Se esse limite for excedido, a chamada da API será limitada, o que pode afetar seus negócios. Chame esta operação conforme necessário.

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

yundun-sddp:DescribeDataObjects

get

*Todos os recursos.

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang	string	Não	O idioma da solicitação e da resposta. Valor padrão: zh_cn. Valores válidos: zh_cn: Chinês. en_us: Inglês.	zh_cn
PageSize	integer	Não	O número máximo de instâncias de ativos de dados a serem retornadas por página em uma consulta paginada. Valor padrão: 10.	10
CurrentPage	integer	Não	O número da página em uma consulta paginada. Valor padrão: 1.	1
ProductIds	string	Não	Recomenda-se especificar este parâmetro. A lista de IDs de produtos a serem consultados, separados por vírgulas. Valores válidos: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis Nota O OSS é mutuamente exclusivo com outros produtos. Se o OSS estiver incluído na consulta, nenhum outro produto poderá ser especificado. Por padrão, produtos não OSS são consultados.	1,5
ParentCategoryIds	string	Não	A lista de IDs de categorias pai dos modelos a serem consultados, separados por vírgulas.	234,236,238
QueryName	string	Não	A palavra-chave do objeto de dados a ser consultado.	t_sddp_selfmysql_pers0
ServiceRegionId	string	Não	A região onde o ativo reside. Valores válidos: cn-beijing: China (Pequim). cn-zhangjiakou: China (Zhangjiakou). cn-huhehaote: China (Hohhot). cn-hangzhou: China (Hangzhou). cn-shanghai: China (Xangai). cn-shenzhen: China (Shenzhen). cn-hongkong: Hong Kong (China).	cn-hangzhou
TemplateId	integer	Sim	O ID do modelo de setor. Nota Você pode chamar DescribeCategoryTemplateList para obter o ID do modelo de setor.	1
DomainId	integer	Não	O ID do domínio de dados ao qual o ativo de dados pertence.	2
ModelTagIds	string	Não	As tags de dados a serem consultadas, separadas por vírgulas. Valores válidos: 101: informações pessoais sensíveis. 102: informações pessoais. 107: informações gerais.	101,102
RiskLevels	string	Não	Os níveis de risco dos ativos de dados a serem consultados. Separe vários valores com vírgulas (,). 2: S1, nível de risco baixo. 3: S2, nível de risco médio. 4: S3, nível de risco alto. 5: S4, nível de risco mais alto.	2
InstanceId	string	Não	A palavra-chave do ID da instância do ativo.	8vb54hn2g9j191ddz
ModelIds	string	Não	Os IDs de modelo do modelo de setor, separados por vírgulas. Nota Você pode chamar DescribeTemplateAllRules para obter os IDs de modelo do modelo de setor.	101
FileType	integer	Não	O tipo de arquivo OSS suportado para detecção. Nota Você pode chamar DescribeDocTypes para obter os tipos de arquivo OSS suportados. Use o valor do campo Code da resposta. Este parâmetro é válido apenas para consultas de ativos OSS.	100001
FileCategoryCode	integer	Não	O código da categoria do arquivo.	1
MemberAccount	integer	Não	O ID das contas de membro.	**********8103
FeatureType	integer	Não	[Descontinuado] Este parâmetro foi descontinuado.	2
APIVersion	integer	Não	O identificador usado para avaliação de versão canary.	1
RegionId	string	Não	A região da página de exibição do catálogo de dados.	cn-zhangjiakou
ProductId	integer	Não	O produto do catálogo de dados.	5
RuleIds	string	Não	O filtro de regra.	1,2,3
RiskLevelIdList	string	Não	O filtro de nível de risco.	1,2,3
TableName	string	Não	O filtro de nome da tarefa.	TableName
DbName	string	Não	O filtro de nome do banco de dados.	dataBaseName
TaskId	integer	Não	O filtro de ID da tarefa.	1
Bucket	string	Não	O filtro de bucket OSS.	bucketName
Project	string	Não	O filtro de projeto SLS.	project
LogStore	string	Não	O filtro de Logstore SLS.	logstore
LogStoreFlag	integer	Não	A página SLS do catálogo de dados possui duas camadas. Este parâmetro indica se a consulta está na dimensão do Logstore.	1
Path	string	Não	O filtro de caminho de arquivo.	road
EngineType	string	Não
Cursor	string	Não	A dimensão de faceta para filtragem associada no catálogo de dados. Valores válidos: rule (categoria), task (tarefa), instance (instância) e db (banco de dados). Se este parâmetro não for especificado ou estiver vazio, a consulta original de lista e contagem será realizada (comportamento inalterado). Se um valor válido for especificado, a consulta de lista será ignorada e apenas content.hitValues será retornado. Se um valor inválido for especificado, um erro de parâmetro será retornado.	instance
CursorDirection	string	Não	Especifica se deve filtrar itens de revisão.	0
		Não
		Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CurrentPage	integer	O número da página atual em uma consulta paginada. Configurações para paginação. Valor padrão: 1.	1
RequestId	string	O ID da solicitação. O ID é um identificador exclusivo que o Alibaba Cloud gera para a solicitação e pode ser usado para solucionar problemas.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	O número máximo de instâncias de ativos de dados a serem retornadas por página em uma consulta paginada. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	21
Items	array<object>	A lista de objetos de dados.
	array<object>	A lista de objetos de dados.
Name	string	O nome do objeto de dados.	t_sddp_selfmysql_pers0
Id	string	O ID exclusivo do objeto de dados.	20000
TemplateId	integer	O ID do modelo de setor.	1
ProductId	integer	O ID que corresponde ao nome do produto ao qual o objeto de dados pertence. Valores válidos: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5
InstanceDescription	string	A descrição da instância do objeto de dados.	descrição da instância
ProductCode	string	O nome do produto ao qual o objeto de dados pertence. Valores válidos: MaxCompute OSS ADB-MYSQL TableStore RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	O número de entradas de dados sensíveis.	1
ObjectType	string	O tipo de objeto do objeto de dados.	tipo de texto
Path	string	O caminho do objeto de dados.	rm-12.db_*
RegionName	string	O nome da região.	cn-hangzhou
Categories	array	A lista de categorias de setor às quais os dados sensíveis pertencem.
	string	A lista de categorias de setor às quais os dados sensíveis pertencem. Várias categorias são separadas por vírgulas.	informações sensíveis gerais
ModelTags	array<object>	A lista de rótulos de dados.
	object	A lista de rótulos de dados.
Id	integer	O ID do rótulo de dados. Valores válidos: 101: Informações pessoais sensíveis. 102: Informações pessoais. 107: Informações gerais.	101
Name	string	O nome do rótulo de dados. Valores válidos: Informações pessoais sensíveis. Informações pessoais. Informações gerais.	Informações pessoais sensíveis
RuleList	array<object>	A lista de modelos de detecção correspondentes.
	object	A lista de modelos de detecção correspondentes.
RuleId	integer	O ID do modelo de detecção.	1080
RuleName	string	O nome do modelo de detecção.	nome
RiskLevelId	integer	O ID do nível de risco da regra de detecção de dados sensíveis. Valores válidos: 1: N/A. Nenhum dado sensível foi detectado. 2: S1. Dados sensíveis de nível 1. 3: S2. Dados sensíveis de nível 2. 4: S3. Dados sensíveis de nível 3. 5: S4. Dados sensíveis de nível 4.	2
RiskLevelName	string	O nome do nível de risco da tabela de ativos de dados. Valores válidos: N/A: Nenhum dado sensível foi detectado. S1: Dados sensíveis de nível 1. S2: Dados sensíveis de nível 2. S3: Dados sensíveis de nível 3. S4: Dados sensíveis de nível 4.	S1
RuleCount	integer	O número de modelos de detecção correspondentes.	590
RuleCategoryNameList	string	As informações da regra descritas de cima para baixo do modelo.	Informações pessoais sensíveis-Cartão de identidade
SampleList	string	Os dados de amostra.	["Lucy"，"Tom"]
ObjectFileCategory	string	O nome da categoria do arquivo.	arquivo de texto
MemberAccount	integer	O ID das contas de membro.	**********8103
LastModifiedTime	integer	A hora da última modificação do arquivo, em milissegundos.	1687676649830
InstanceId	string	O ID da instância do ativo de dados.	rm-12*****
LastScanTime	integer	O carimbo de data/hora da última verificação, em milissegundos.	1687676649830
RegionId	string	O ID da região à qual o objeto de dados pertence.	cn-hangzhou
Comment	string	O comentário da coluna.	comentário
DataType	string	O tipo de coluna de banco de dados.	varchar
EngineType	string	O tipo de mecanismo.	TABLE
DbName	string	O nome do banco de dados.	DataBaseName
TableName	string	O nome da tabela.	tableName
RiskLevelId	integer	O nível de sensibilidade.	1
TaskId	integer	O ID da tarefa.	1
TaskNumber	integer	O número da tarefa do usuário.	1000
TaskName	string	O nome da tarefa.	test-task
IsRevision	integer	O status de revisão.	-1
MaskStatus	integer	O status de criptografia da coluna.	-1
FileCategoryCode	integer	O tipo de arquivo.	1
Size	integer	O tamanho do arquivo.	1000
RuleCount	integer	O número de regras correspondentes.	10
Sx	string	O array que consiste no número de regras correspondentes em cada nível de sensibilidade, no formato "S1,S2,S3,S4,S5,S6,S7,S8,S9,S10", onde S1 representa o número de regras correspondentes no nível de sensibilidade S1.	1,2,3,0,0,0,0,5,0,0
TemplateName	string	O nome do modelo.	teste
Project	string	O projeto do Simple Log Service (SLS).	project
LogStore	string	O Logstore do SLS.	logStore
ClusterType	string
HitValues	array	Os valores de filtro associado usados para retornar valores filtrados.	["linxiu","sddptest"]
	string	O primeiro valor correspondido pelo nó raiz.	linxiu
SyncStatus	string
PreviousCursor	string
NextCursor	string
HasPrevious	boolean
HasNext	boolean
ErrorCode	string
ErrorMessage	string

Exemplos

Resposta de sucesso

JSON formato

{
  "CurrentPage": 1,
  "RequestId": "E6F6460E-4330-549A-BD89-C183FB17571E",
  "PageSize": 10,
  "TotalCount": 21,
  "Items": [
    {
      "Name": "t_sddp_selfmysql_pers0",
      "Id": "20000",
      "TemplateId": 1,
      "ProductId": 5,
      "InstanceDescription": "descrição da instância",
      "ProductCode": "RDS",
      "SensitiveCount": 1,
      "ObjectType": "tipo de texto",
      "Path": "rm-12**.db_***",
      "RegionName": "cn-hangzhou",
      "Categories": [
        "informações sensíveis gerais"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "Informações pessoais sensíveis"
        }
      ],
      "RuleList": [
        {
          "RuleId": 1080,
          "RuleName": "nome",
          "RiskLevelId": 2,
          "RiskLevelName": "S1",
          "RuleCount": 590,
          "RuleCategoryNameList": "Informações pessoais sensíveis-Documento de identidade",
          "SampleList": "[\"Lucy\"，\"Tom\"]"
        }
      ],
      "ObjectFileCategory": "arquivo de texto",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "comentário",
      "DataType": "varchar",
      "EngineType": "TABLE",
      "DbName": "DataBaseName",
      "TableName": "tableName",
      "RiskLevelId": 1,
      "TaskId": 1,
      "TaskNumber": 1000,
      "TaskName": "test-task",
      "IsRevision": -1,
      "MaskStatus": -1,
      "FileCategoryCode": 1,
      "Size": 1000,
      "RuleCount": 10,
      "Sx": "1,2,3,0,0,0,0,5,0,0",
      "TemplateName": "teste",
      "Project": "project",
      "LogStore": "logStore",
      "ClusterType": ""
    }
  ],
  "HitValues": [
    "linxiu"
  ],
  "SyncStatus": "",
  "PreviousCursor": "",
  "NextCursor": "",
  "HasPrevious": false,
  "HasNext": false,
  "ErrorCode": "",
  "ErrorMessage": ""
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.