Todos os produtos
Search

Este produto

    Data Management:GetProxy

    Central de documentação

    Data Management:GetProxy

    Última atualização: Jun 29, 2026

    Consulta os detalhes de um 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:GetProxy

    get

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    ProxyId

    integer

    Sim

    O ID do proxy de acesso seguro. Você pode chamar a operação ListProxies para consultar o ID do proxy de acesso seguro.

    4**
    Tid

    integer

    Não

    O ID do locatário. Você pode chamar a operação GetUserActiveTenant para obter o ID do locatário.

    3***

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Esquema da resposta.

    RequestId

    string

    O ID da solicitação.

    F49D4598-2B3C-5723-865E-2CCB818E****
    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 retornada se a solicitação falhar.

    The condition cannot be empty!
    ErrorCode

    string

    O código de erro retornado se a solicitação falhar.

    UnknownError
    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 foi 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 foi ativado. Valores válidos:

    • true: O endpoint público foi ativado.

    • false: O endpoint público foi desativado.

    true
    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 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 Alibaba Cloud DNS será retornado.

    dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com
    HttpsPort

    integer

    O número da porta usada pelo protocolo HTTPS.

    443
    ProtocolType

    string

    O tipo de protocolo do banco de dados. Exemplo: MYSQL.

    MYSQL
    ProtocolPort

    integer

    O número da porta usada pelo protocolo.

    3306
    RegionId

    string

    O ID da região na qual a instância reside.

    cn-hangzhou

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "F49D4598-2B3C-5723-865E-2CCB818E****",
  "Success": true,
  "ErrorMessage": "The condition cannot be empty!",
  "ErrorCode": "UnknownError",
  "ProxyId": 0,
  "CreatorId": 0,
  "CreatorName": "test_name",
  "InstanceId": 0,
  "PrivateEnable": true,
  "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "PublicEnable": true,
  "PublicHost": "dphzmy-5j8oimjsz6zed7k****.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.