Consultar um endpoint de proxy - : Central de Documentação do Alibaba Cloud

Antes de chamar a operação DescribeDBProxyEndpoint, verifique se a operação ModifyDBProxy foi chamada para ativar o recurso de proxy de banco de dados na instância.

O recurso de proxy dedicado do ApsaraDB RDS for MySQL oferece funcionalidades como divisão de leitura e escrita e otimização de conexões de curta duração. Para mais informações, consulte O que são proxies de banco de dados?
O recurso de proxy de banco de dados do ApsaraDB RDS for PostgreSQL oferece suporte à divisão de leitura e escrita. Para mais informações, consulte O que são proxies de banco de dados?

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBProxyEndpoint	A operação a ser executada. Defina o valor como DescribeDBProxyEndpoint.
DBInstanceId	String	Sim	rm-bp1ja4f56s7us****	O ID da instância. Chame a operação DescribeDBInstances para consultar o ID da instância.
DBProxyEndpointId	String	Não	keaxncrjluwu0gue****	O nome do terminal de proxy ao qual o endpoint de proxy pertence. Chame a operação DescribeDBProxy para consultar o nome do terminal de proxy.
DBProxyConnectString	String	Não	testproxy****.rwlb.rds.aliyuncs.com	O endpoint de proxy a ser consultado. Chame a operação DescribeDBProxy para consultar o endpoint de proxy.
RegionId	String	Sim	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para obter a lista de regiões mais recente.
DBProxyEngineType	String	Não	normal	Um parâmetro interno. Não é necessário especificar este parâmetro.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
DBProxyConnectStringNetType	String	InnerString	O tipo de rede do endpoint de proxy. Valores válidos: InnerString: rede interna OuterString: Internet
DBProxyFeatures	String	TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1	A configuração do terminal de proxy. O valor deste parâmetro é uma string JSON composta pelos seguintes campos: TransactionReadSqlRouteOptimizeStatus: status do recurso de divisão de transações. Valores válidos: 0 e 1. O valor 0 indica que o recurso está desativado. O valor 1 indica que o recurso está ativado. ConnectionPersist: status do recurso de pool de conexões. Valores válidos: 0, 1 e 2. O valor 0 indica que o recurso de pool de conexões está desativado. O valor 1 indica que o pool de conexões de sessão está ativado. O valor 2 indica que o pool de conexões de transação está ativado. ReadWriteSpliting: status do recurso de divisão de leitura e escrita. Valores válidos: 0 e 1. O valor 0 indica que o recurso está desativado. O valor 1 indica que o recurso está ativado. PinPreparedStmt: campo interno disponível apenas para instâncias do ApsaraDB RDS for PostgreSQL. Nota Se a instância executar PostgreSQL, será possível alterar apenas o valor do campo ReadWriteSpliting. Os campos TransactionReadSqlRouteOptimizeStatus e PinPreparedStmt mantêm seus valores padrão 1.
RequestId	String	847BA085-B377-4BFA-8267-F82345ECE1D2	O ID da solicitação.
ReadOnlyInstanceWeight	String	[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z**\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c**\",\"NodeType\":\"Secondary\",\"Weight\":400}]]	Os pesos de leitura da instância e de suas instâncias somente leitura. O valor deste parâmetro é uma string JSON composta pelos seguintes campos: DBInstanceId: ID da instância. DBInstanceType: função da instância. Valores válidos: Master e ReadOnly. NodeID: IDs dos nós primário e secundário na instância principal, caso a instância execute a RDS Cluster Edition. NodeType: tipo de nó, caso a instância execute a RDS Cluster Edition. Valores válidos: Primary e Secondary. O valor Primary indica o nó primário na instância principal. O valor Secondary indica o nó secundário na instância principal. Weight: peso de leitura da instância. O peso de leitura aumenta em incrementos de 100 e não pode exceder 10000.
ReadOnlyInstanceDistributionType	String	Standard	O método usado para atribuir pesos de leitura. Para mais informações, consulte Modificar o limiar de latência e os pesos de leitura de instâncias do ApsaraDB RDS for MySQL. Valores válidos: Standard: o ApsaraDB RDS aloca automaticamente pesos de leitura para a instância e suas instâncias somente leitura com base nas especificações das instâncias. Custom: atribua manualmente os pesos de leitura para a instância e suas instâncias somente leitura.
ReadOnlyInstanceMaxDelayTime	String	30	O limiar de latência permitido para a divisão de leitura e escrita. Se a latência em uma instância somente leitura ultrapassar o limiar especificado, o ApsaraDB RDS deixará de encaminhar solicitações de leitura para essa instância.
DbProxyEndpointReadWriteMode	String	ReadWrite	Os atributos de leitura e escrita do terminal de proxy. Valores válidos: ReadWrite: o terminal de proxy oferece suporte a solicitações de leitura e escrita. ReadOnly: o terminal de proxy oferece suporte apenas a solicitações de leitura.
DbProxyEndpointAliases	String	proxyterminal-test	A descrição do terminal de proxy.
DBProxyEndpointId	String	keaxncrjluwu0gue****	O ID do endpoint de proxy.
DBProxyConnectStringPort	String	3306	O número da porta associada ao endpoint de proxy.
DBProxyConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	O endpoint de proxy consultado.
DBProxyEngineType	String	normal	Um parâmetro interno. Ignore este parâmetro.
EndpointConnectItems	Array of EndpointConnectItems		Uma matriz contendo as informações sobre o endpoint de proxy.
EndpointConnectItems
DbProxyEndpointPort	String	3306	O número da porta associada ao endpoint de proxy. Valor padrão: 3306.
DbProxyEndpointConnectString	String	testproxy****.rwlb.rds.aliyuncs.com	O endpoint de proxy consultado.
DbProxyEndpointNetType	String	2	O tipo de rede do endpoint de proxy. Valores válidos: 0: Internet 1: rede clássica 2: virtual private cloud (VPC)

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyEndpoint
&DBInstanceId=rm-bp1ja4f56s7us****
&RegionId=cn-hangzhou
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeDBProxyEndpointResponse>
    <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
    <DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1</DBProxyFeatures>
    <RequestId>847BA085-B377-4BFA-8267-F82345ECE1D2</RequestId>
    <ReadOnlyInstanceWeight>[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp****\",\"DBInstanceType\":\"ReadOnly\",\"NodeId\":\"rr-bp****\",\"NodeType\":\"ReadOnly\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-2\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-3\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rm-2z****-instance-1\",\"NodeType\":\"Primary\",\"Weight\":0}]]</ReadOnlyInstanceWeight>
    <ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
    <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
    <DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
    <DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
    <DBProxyEndpointId>keaxncrjluwu0gue****</DBProxyEndpointId>
    <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
    <DBProxyConnectString>testproxy****.rwlb.rds.aliyuncs.com</DBProxyConnectString>
    <DBProxyEngineType>normal</DBProxyEngineType>
    <EndpointConnectItems>
        <DbProxyEndpointPort>3306</DbProxyEndpointPort>
        <DbProxyEndpointConnectString>testproxy****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
        <DbProxyEndpointNetType>2</DbProxyEndpointNetType>
    </EndpointConnectItems>
</DescribeDBProxyEndpointResponse>

Formato JSON

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

{
  "DBProxyConnectStringNetType" : "InnerString",
  "DBProxyFeatures" : "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId" : "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ReadOnlyInstanceWeight" : "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rr-bp****\\\",\\\"DBInstanceType\\\":\\\"ReadOnly\\\",\\\"NodeId\\\":\\\"rr-bp****\\\",\\\"NodeType\\\":\\\"ReadOnly\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-2\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-3\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rm-2z****-instance-1\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}]]",
  "ReadOnlyInstanceDistributionType" : "Standard",
  "ReadOnlyInstanceMaxDelayTime" : "30",
  "DbProxyEndpointReadWriteMode" : "ReadWrite",
  "DbProxyEndpointAliases" : "proxyterminal-test",
  "DBProxyEndpointId" : "keaxncrjluwu0gue****",
  "DBProxyConnectStringPort" : "3306",
  "DBProxyConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyEngineType" : "normal",
  "EndpointConnectItems" : [ {
    "DbProxyEndpointPort" : "3306",
    "DbProxyEndpointConnectString" : "testproxy****.rwlb.rds.aliyuncs.com",
    "DbProxyEndpointNetType" : "2"
  } ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidEndPoint.Format	The specified EndPoint is not valid.	Mensagem de erro retornada porque o parâmetro DBProxyEndpointId não foi especificado ou o ID indicado por esse parâmetro não foi encontrado.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	Mensagem de erro retornada porque o valor do parâmetro DBInstanceName é inválido. Verifique se o valor é nulo ou uma string vazia.
400	Endpoint.NotFound	The specified EndPoint is not valid.	Mensagem de erro retornada porque o terminal de proxy especificado não existe.
403	IncorrectKindCode	The current KindCode of the custins does not support the operation.	Mensagem de erro retornada porque a configuração da instância não oferece suporte a esta operação. Verifique a configuração da instância principal.
403	IncorrectDBInstanceType	The current database instance type does not support the operation.	Mensagem de erro retornada porque a configuração da instância não oferece suporte a esta operação.
404	Endpoint.NotFound	Specified endpoint is not found.	Mensagem de erro retornada porque o número da porta especificado não foi encontrado.

Para obter uma lista de códigos de erro, visite o API Error Center.