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

Obtém a lista de instâncias de ativos de dados para conexões autorizadas do MaxCompute, ApsaraDB RDS e OSS.

Descrição da operação

Ao chamar a operação DescribeInstances, você pode definir parâmetros como palavras-chave de pesquisa e níveis de risco das instâncias de ativos de dados para obter uma lista de instâncias de ativos de dados que atendem às condições especificadas.

Limite de QPS

O limite de QPS por usuário único para esta operação é de 10 chamadas por segundo. Se o número de chamadas exceder o limite, o throttling será acionado, 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:DescribeInstances

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 (Simplificado). en_us: Inglês (EUA).	zh_cn
Name	string	Não	A palavra-chave de pesquisa. Há suporte para correspondência difusa. Por exemplo, se você inserir data, todas as entradas de dados que contêm data no item de pesquisa serão retornadas.	data
ProductId	integer	Não	O ID do produto ao qual a instância de ativo de dados pertence. Você pode chamar a operação DescribeDataAssets para obter o ID do produto.	1
RiskLevelId	integer	Não	O ID do nível de risco da instância de ativo de dados. Um ID de nível de risco mais alto indica que dados mais sensíveis foram detectados. Valores válidos: 1: Nenhum dado sensível detectado. Sem risco. 2: Risco de dados sensíveis no nível 1. 3: Risco de dados sensíveis no nível 2. 4: Risco de dados sensíveis no nível 3. 5: Risco de dados sensíveis no nível 4. 6: Risco de dados sensíveis no nível 5. 7: Risco de dados sensíveis no nível 6. 8: Risco de dados sensíveis no nível 7. 9: Risco de dados sensíveis no nível 8. 10: Risco de dados sensíveis no nível 9. 11: Risco de dados sensíveis no nível 10.	2
RuleId	integer	Não	O ID da regra de detecção de dados sensíveis que a instância de ativo de dados atingiu. Você pode chamar a operação DescribeRules e obter o ID da regra no parâmetro de resposta Id.	1111111
ServiceRegionId	string	Não	A região da instância de ativo de dados. Para mais informações, consulte Regiões suportadas.	cn-hangzhou
FeatureType	integer	Não	Este parâmetro está obsoleto.	1
ProductCode	string	Não	O nome do produto ao qual a instância de ativo de dados pertence, como MaxCompute, OSS ou RDS. Para nomes de produtos suportados, consulte Tipos de dados nos quais dados sensíveis podem ser detectados.	RDS
PageSize	integer	Não	O número máximo de instâncias de ativos de dados a serem retornadas em cada página em uma consulta paginada. Valor padrão: 10.	10
CurrentPage	integer	Não	O número da página atual em uma consulta paginada. Valor padrão: 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CurrentPage	integer	O número da página atual.	1
RequestId	string	O ID da solicitação.	71064826-726F-4ADA-B879-05D8055476FB
PageSize	integer	O número de instâncias de ativos de dados em cada página.	10
TotalCount	integer	O número total de instâncias de ativos de dados retornadas.	231
Items	array<object>	Os detalhes das instâncias de ativos de dados retornadas.
	array<object>
CreationTime	integer	A hora em que a instância de ativo de dados foi criada. O valor é um timestamp UNIX. Unidade: milissegundos.	1637226782000
LastFinishTime	integer	A hora em que a verificação mais recente da instância de ativo de dados foi concluída. O valor é um timestamp UNIX. Unidade: milissegundos.	1637622793000
Owner	string	A conta Alibaba Cloud que possui a instância de ativo de dados.	dtdep-239-******
TenantName	string	O nome do locatário.	tenant
Protection	boolean	O status de proteção da instância de ativo de dados. Valores válidos: true: Protegido. false: Não protegido.	false
DepartName	string	O nome do departamento ao qual a instância de ativo de dados pertence.	***DemoCenter
Labelsec	boolean	O status de segurança da instância de ativo de dados. Valores válidos: true: Seguro. false: Não seguro.	true
RiskLevelId	integer	O ID do nível de risco da instância de ativo de dados. Um ID de nível de risco mais alto indica que dados mais sensíveis foram detectados. 1: Nenhum dado sensível detectado. Sem risco. 2: Risco de dados sensíveis no nível 1. 3: Risco de dados sensíveis no nível 2. 4: Risco de dados sensíveis no nível 3. 5: Risco de dados sensíveis no nível 4. 6: Risco de dados sensíveis no nível 5. 7: Risco de dados sensíveis no nível 6. 8: Risco de dados sensíveis no nível 7. 9: Risco de dados sensíveis no nível 8. 10: Risco de dados sensíveis no nível 9. 11: Risco de dados sensíveis no nível 10.	2
ProductId	string	O ID do produto ao qual a instância de ativo de dados pertence.	5
Name	string	O nome da instância de ativo de dados.	gxdata
TotalCount	integer	O número total de itens de dados na instância de ativo de dados. Por exemplo, se o ativo de dados for ApsaraDB RDS, este valor indica o número total de tabelas nos bancos de dados da instância.	231
InstanceDescription	string	A descrição da instância de ativo de dados.	instance dscription
RuleName	string	O nome da regra de detecção de dados sensíveis que a instância de ativo de dados atingiu.	*** rule
Sensitive	boolean	Indica se a instância de ativo de dados contém dados sensíveis. Valores válidos: true: Contém dados sensíveis. false: Não contém dados sensíveis.	true
RiskLevelName	string	O nome do nível de risco da instância de ativo de dados.	S1
OdpsRiskLevelName	string	Este parâmetro está obsoleto.	1
SensitiveCount	integer	O número total de itens de dados sensíveis na instância de ativo de dados. Por exemplo, se o ativo de dados for ApsaraDB RDS, este valor indica o número total de tabelas sensíveis nos bancos de dados da instância.	123
Id	integer	O ID exclusivo da instância de ativo de dados registrado no Data Security Center.	11111
ProductCode	string	O nome do produto ao qual a instância de ativo de dados pertence, como MaxCompute, OSS ou RDS. Para nomes de produtos suportados, consulte Tipos de dados nos quais dados sensíveis podem ser detectados.	RDS
ModelTags	array<object>	A lista de tags de dados.
	object	O objeto de tag 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	personal sensitive data
MemberAliUid	string	Se a conta de gerenciamento tiver ativado o gerenciamento de múltiplas contas e o ativo pertencer a outra conta membro, este campo exibirá o UID da conta membro.	12567890126

Exemplos

Resposta de sucesso

JSON formato

{
  "CurrentPage": 1,
  "RequestId": "71064826-726F-4ADA-B879-05D8055476FB",
  "PageSize": 10,
  "TotalCount": 231,
  "Items": [
    {
      "CreationTime": 1637226782000,
      "LastFinishTime": 1637622793000,
      "Owner": "dtdep-239-******",
      "TenantName": "tenant",
      "Protection": false,
      "DepartName": "***DemoCenter",
      "Labelsec": true,
      "RiskLevelId": 2,
      "ProductId": "5",
      "Name": "gxdata",
      "TotalCount": 231,
      "InstanceDescription": "instance dscription",
      "RuleName": "*** rule",
      "Sensitive": true,
      "RiskLevelName": "S1",
      "OdpsRiskLevelName": "1",
      "SensitiveCount": 123,
      "Id": 11111,
      "ProductCode": "RDS",
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ],
      "MemberAliUid": "12567890126"
    }
  ]
}

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.