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

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

Descrição da operação

Esta operação consulta os resultados de detecção de dados para tabelas e arquivos, para fornecer uma visão abrangente de todos os seus ativos.

Limite de QPS

O limite de QPS por usuário para esta operação é de 10 solicitações por segundo. Se você exceder esse limite, o sistema limitará suas chamadas de API. Para evitar interrupções nos negócios, chame esta operação apenas quando 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

*All Resource

*

acs:ResourceGroupId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Lang	string	Não	O idioma do conteúdo na solicitação e na 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 de ativos de dados a serem retornados em cada página. Valor padrão: 10.	10
CurrentPage	integer	Não	O número da página retornada. Valor padrão: 1.	1
ProductIds	string	Não	Os IDs dos produtos aos quais os ativos de dados a serem consultados pertencem. Você pode especificar vários IDs de produtos. Separe-os com vírgulas (,). Recomendamos que você especifique este parâmetro. 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 Se você quiser consultar ativos de dados pertencentes ao OSS, não poderá consultar ativos de dados de outros produtos. Por padrão, os ativos de dados de produtos diferentes do OSS são consultados.	1,5
ParentCategoryIds	string	Não	Os IDs das categorias de ativos pai a serem consultadas. Você pode especificar vários IDs. Separe-os com vírgulas (,).	234,236,238
QueryName	string	Não	A palavra-chave do ativo de dados a ser consultado.	t_sddp_selfmysql_pers0
ServiceRegionId	string	Não	A região onde o ativo de dados 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: China (Hong Kong)	cn-hangzhou
TemplateId	integer	Sim	O ID do modelo de regra específico do setor. Nota Você pode chamar a operação DescribeCategoryTemplateList para obter o ID do modelo de regra específico do 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	Os rótulos de dados a serem consultados. Você pode especificar vários rótulos de dados. Separe-os com 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	O nível de sensibilidade do ativo de dados. Você pode especificar vários níveis de sensibilidade. Separe-os com vírgulas (,). 2: S1, nível de sensibilidade baixo 3: S2, nível de sensibilidade médio 4: S3, nível de sensibilidade alto 5: S4, nível de sensibilidade mais alto	2
InstanceId	string	Não	A palavra-chave do ID da instância.	8vb54hn2g9j191ddz
ModelIds	string	Não	O ID do modelo de regra específico do setor. Você pode especificar vários IDs. Separe-os com vírgulas (,). Nota Você pode chamar a operação DescribeTemplateAllRules para obter o ID do modelo de regra específico do setor.	101
FileType	integer	Não	O tipo do arquivo OSS. Nota Este parâmetro é válido apenas para consultar ativos de dados do tipo OSS. Você pode chamar a operação DescribeDocTypes para obter os tipos de arquivo OSS suportados. Use o valor do parâmetro Code na resposta.	100001
FileCategoryCode	integer	Não	O código da categoria do arquivo.	1
MemberAccount	integer	Não	O ID do membro.	**********8103
FeatureType	integer	Não	Este parâmetro foi descontinuado.	2
APIVersion	integer	Não	A versão da API.	1
RegionId	string	Não	A região na qual o catálogo de ativos de dados reside.	cn-zhangjiakou
ProductId	integer	Não	O ID do produto.	5
RuleIds	string	Não	Os IDs das regras. Você pode especificar vários IDs de regras. Separe-os com vírgulas (,).	1,2,3
RiskLevelIdList	string	Não	Os IDs dos níveis de sensibilidade. Você pode especificar vários IDs de níveis de sensibilidade. Separe-os com vírgulas (,).	1,2,3
TableName	string	Não	O nome da tabela.	TableName
DbName	string	Não	O nome do banco de dados.	dataBaseName
TaskId	integer	Não	O ID da tarefa.	1
Bucket	string	Não	O nome do bucket do OSS.	bucketName
Project	string	Não	O nome do projeto do Simple Log Service.	project
LogStore	string	Não	O nome do Logstore.	logstore
LogStoreFlag	integer	Não	Especifica se os dados devem ser consultados no nível do Logstore. O catálogo de dados do Simple Log Service possui duas camadas. Defina este parâmetro como 1 para consultar dados no nível do Logstore.	1
Path	string	Não	O caminho do arquivo.	road

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CurrentPage	integer	O número da página a ser retornada. Valor padrão: 1.	1
RequestId	string	O ID exclusivo da solicitação. A Alibaba Cloud gera este ID para ajudar você a solucionar problemas.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	O número de instâncias de ativos de dados a serem retornadas em cada página. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas que correspondem à consulta.	21
Items	array<object>	Uma lista de objetos de dados.
	array<object>	Um objeto 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 do produto ao qual o objeto de dados pertence. Valores válidos: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: Table Store 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 ativo de dados.	instance description
ProductCode	string	O nome do produto ao qual o objeto de dados pertence. Valores válidos: MaxCompute OSS ADB-MYSQL Table Store RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	O número de campos de dados sensíveis.	1
ObjectType	string	O tipo do objeto de dados.	text type
Path	string	O caminho do objeto de dados.	rm-12.db_*
RegionName	string	O nome da região.	cn-hangzhou
Categories	array	Uma matriz de categorias de setor às quais os dados sensíveis pertencem.
	string	A classificação de setor dos dados sensíveis.	general sensitive information
ModelTags	array<object>	Uma lista de tags de dados.
	object	Uma tag de dados.
Id	integer	The ID of the data tag. Valid values: 101: Personal sensitive information 102: Personal information 107: General information	101
Name	string	The name of the data tag. Valid values: Personal sensitive information Personal information General information	Personal sensitive information
RuleList	array<object>	Uma lista de modelos de detecção correspondentes.
	object	Um modelo de detecção correspondente.
RuleId	integer	The ID of the detection model.	1080
RuleName	string	The name of the detection model.	name
RiskLevelId	integer	The ID of the risk level. Valid values: 1: N/A - No sensitive data is detected 2: S1 - Level-1 sensitive data 3: S2 - Level-2 sensitive data 4: S3 - Level-3 sensitive data 5: S4 - Level-4 sensitive data	2
RiskLevelName	string	The name of the risk level. Valid values: N/A: No sensitive data is detected S1: Level-1 sensitive data S2: Level-2 sensitive data S3: Level-3 sensitive data S4: Level-4 sensitive data	S1
RuleCount	integer	The number of matched detection models.	590
RuleCategoryNameList	string	The hierarchical category of the rule, from the top-level to the leaf-level category in the template.	Personal sensitive information-ID card
SampleList	string	The sample data.	["Lucy"，"Tom"]
ObjectFileCategory	string	O nome da categoria do arquivo.	text file
MemberAccount	integer	O ID da conta 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 e hora da última verificação, em milissegundos.	1687676649830
RegionId	string	O ID da região onde o objeto de dados está localizado.	cn-hangzhou
Comment	string	O comentário na coluna.	comment
DataType	string	O tipo de dados da coluna do banco de dados.	varchar
DbName	string	O nome do banco de dados.	DataBaseName
TableName	string	O nome da tabela.	tableName
RiskLevelId	integer	O nível de risco.	1
TaskId	integer	O ID da tarefa.	1
TaskNumber	integer	O número da tarefa.	1000
TaskName	string	O nome da tarefa.	test-task
IsRevision	integer	O status de revisão.	-1
MaskStatus	integer	O status de mascaramento da coluna.	-1
FileCategoryCode	integer	O código da categoria do arquivo.	1
Size	integer	O tamanho do arquivo em bytes.	1000
RuleCount	integer	O número de regras correspondentes.	10
Sx	string	Uma string separada por vírgulas que especifica a contagem de regras correspondentes para cada nível de risco. A string segue o formato S1,S2...S10, onde o valor em cada posição representa a contagem para o nível de risco correspondente.	1,2,3,0,0,0,0,5,0,0
TemplateName	string	O nome do modelo.	test
Project	string	O nome do projeto do Simple Log Service (SLS).	project
LogStore	string	O nome do Logstore no SLS.	logStore
ClusterType	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": "instance description",
      "ProductCode": "RDS",
      "SensitiveCount": 1,
      "ObjectType": "text type",
      "Path": "rm-12**.db_***",
      "RegionName": "cn-hangzhou",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "Personal sensitive information"
        }
      ],
      "RuleList": [
        {
          "RuleId": 1080,
          "RuleName": "name",
          "RiskLevelId": 2,
          "RiskLevelName": "S1",
          "RuleCount": 590,
          "RuleCategoryNameList": "Personal sensitive information-ID card",
          "SampleList": "[\"Lucy\"，\"Tom\"]"
        }
      ],
      "ObjectFileCategory": "text file",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "comment",
      "DataType": "varchar",
      "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": "test",
      "Project": "project",
      "LogStore": "logStore",
      "ClusterType": ""
    }
  ]
}

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.