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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetProxy	A operação que você deseja executar. Defina o valor como GetProxy.
InstanceId	Long	Não	1	O ID da instância. Chame a operação GetInstance ou ListInstances para obter este parâmetro.
ProxyId	Long	Não	1	O ID do agente de proteção de segurança. Chame a operação ListProxies para obter este parâmetro. Especifique pelo menos um entre este parâmetro e o parâmetro Instance ID.
Tid	Long	Não	1	O ID do locatário. Chame a operação GetUserActiveTenant ou ListUserTenants para obter este parâmetro.
RegionId	String	Não	cn-hangzhou	Selecione a região de serviço do DMS. Esta operação é usada para chamar esta API. Para mais informações, consulte Descrição do parâmetro RegionID. Nota Defina este parâmetro com o ID da região mais próxima das suas aplicações.

Parâmetros de resposta

Parâmetro	Tipo	Resposta de exemplo	Descrição
RequestId	String	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida.
ErrorMessage	String	UnknownError	A mensagem de erro retornada.
ErrorCode	String	200	O código de erro retornado para a tarefa de consulta.
ProxyId	Long	1	O ID do agente de proteção de segurança.
CreatorId	Long	1	O ID de usuário do criador do agente de proteção de segurança.
CreatorName	String	xxx	O apelido de usuário do criador do agente de proteção de segurança.
InstanceId	Long	123456	O ID da instância.
PrivateEnable	Boolean	true	Especifica se o endpoint interno está ativado.
PrivateHost	String	xxx.dms.aliyuncs.com	O endereço IP interno.
PublicEnable	Boolean	true	Especifica se o endpoint público está ativado.
PublicHost	String	xxx.dms.aliyuncs.com	Endpoint público.
MysqlPort	Integer	3306	O número da porta do protocolo MySQL.
HttpsPort	Integer	443	O número da porta do protocolo HTTPS.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=GetProxy
&InstanceId=1
&ProxyId=1
&Tid=1
&<Common request parameters>

Respostas de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<GetProxyResponse>
    <PublicHost>dxxxxy-zxxxxxx7xxxxxxmd-pub.proxy.dms.aliyuncs.com</PublicHost>
    <PrivateHost>dxxxxy-zxxxxxx7xxxxxxmd.proxy.dms.aliyuncs.com</PrivateHost>
    <RequestId>F7DB3F39-062D-50BA-BB10-326BF88E332A</RequestId>
    <InstanceId>1</InstanceId>
    <ProxyId>9</ProxyId>
    <CreatorId>200000</CreatorId>
    <Success>true</Success>
    <MysqlPort>3306</MysqlPort>
    <CreatorName>exxxx</CreatorName>
    <HttpsPort>443</HttpsPort>
</GetProxyResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PublicHost" : "dxxxxy-zxxxxxx7xxxxxxmd-pub.proxy.dms.aliyuncs.com",
  "PrivateHost" : "dxxxxy-zxxxxxx7xxxxxxmd.proxy.dms.aliyuncs.com",
  "RequestId" : "F7DB3F39-062D-50BA-BB10-326BF88E332A",
  "InstanceId" : 1,
  "ProxyId" : 9,
  "CreatorId" : 200000,
  "Success" : true,
  "MysqlPort" : 3306,
  "CreatorName" : "exxxx",
  "HttpsPort" : 443
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros da API.