ListProxies - Data Management: Central de Documentação do Alibaba Cloud

Consulta os proxies gerados pelo recurso de proxy de acesso seguro.

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

dms:ListProxies

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Tid	integer	Não	O ID do tenant. Você pode chamar a operação GetUserActiveTenant para consultar o ID do tenant.	3***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	5812180E-555F-5F90-BE4F-280576F4****
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
ErrorMessage	string	A mensagem de erro.	User can not access to Tenant [123445]
ErrorCode	string	O código de erro.	UnknownError
ProxyList	array<object>	Os proxies gerados pelo recurso de proxy de acesso seguro.
	object	O proxy gerado pelo recurso de proxy de acesso seguro.
ProxyId	integer	O ID do proxy de acesso seguro.	4**
CreatorId	integer	O ID do usuário que ativou o recurso de proxy de acesso seguro.	12****
CreatorName	string	O apelido do usuário que ativou o recurso de proxy de acesso seguro.	test_name
InstanceId	integer	O ID da instância.	183****
PrivateEnable	boolean	Indica se o endpoint interno está ativado. Valor padrão: true.	true
PrivateHost	string	O endpoint interno.	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	Indica se o endpoint público está ativado. Valores válidos: true: O endpoint público está ativado. false: O endpoint público está desativado.	false
PublicHost	string	O endpoint público. Um endpoint público é retornado independentemente de o endpoint público estar ativado ou desativado. Nota Se o valor do parâmetro PublicEnable for true, um endpoint público válido que pode ser resolvido usando o Alibaba Cloud DNS (DNS) será retornado. Se o valor do parâmetro PublicEnable for false, um endpoint público inválido que não pode ser resolvido usando o DNS será retornado.	dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPort	integer	O número da porta usada pelos clientes HTTPS para se conectar à instância de banco de dados.	443
ProtocolType	string	O tipo do banco de dados. Exemplo: MYSQL.	MYSQL
ProtocolPort	integer	O número da porta usada para se conectar à instância de banco de dados.	3306
RegionId	string	O ID da região.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5812180E-555F-5F90-BE4F-280576F4****",
  "Success": true,
  "ErrorMessage": "User can not access to Tenant [123445]",
  "ErrorCode": "UnknownError",
  "ProxyList": [
    {
      "ProxyId": 0,
      "CreatorId": 0,
      "CreatorName": "test_name",
      "InstanceId": 0,
      "PrivateEnable": true,
      "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
      "PublicEnable": false,
      "PublicHost": "dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com",
      "HttpsPort": 443,
      "ProtocolType": "MYSQL",
      "ProtocolPort": 3306,
      "RegionId": "cn-hangzhou"
    }
  ]
}

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.