Consultar configurações de proxy - : Central de Documentação do Alibaba Cloud

Antes de chamar a operação DescribeDBProxy, certifique-se de que a operação ModifyDBProxy tenha sido 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 capacidades como separação de leitura/gravação 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 é compatível com separação de leitura/gravação. 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. 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 requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBProxy	A operação que você deseja executar. Defina o valor como DescribeDBProxy.
DBInstanceId	String	Sim	rm-bp1ja4f56s7us****	O ID da instância. Chame a operação DescribeDBInstances para consultar o ID da instância.
RegionId	String	Não	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
DBProxyEngineType	String	Não	normal	Um parâmetro interno. Não é necessário especificar este parâmetro.
ResourceGroupId	String	Não	rg-acfmy*	O ID do grupo de recursos.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
DBProxyInstanceLatestMinorVersion	String	1.13.12	A versão de proxy mais recente disponível para a instância.
RequestId	String	909A69EE-71C8-4417-A0B9-FF085407E1E3	O ID da requisição.
DBProxyInstanceCurrentMinorVersion	String	1.13.11	A versão de proxy em execução na instância.
DBProxyInstanceNum	Integer	1	O número de proxies ativos na instância.
DBProxyInstanceType	String	2	O tipo de proxy de banco de dados ativo na instância. Valores válidos: 1: proxy compartilhado 2: proxy dedicado Nota As instâncias ApsaraDB RDS for PostgreSQL são compatíveis apenas com proxies dedicados.
DBProxyInstanceStatus	String	Running	O status da instância de proxy. Valores válidos: Creating: A instância de proxy está sendo criada. Running: A instância de proxy está em execução. DBInstanceClassChanging: As especificações da instância de proxy estão sendo alteradas. Deleting: A instância de proxy está sendo excluída.
DBProxyServiceStatus	String	Startup	O status do recurso de proxy de banco de dados. Valores válidos: Startup: ativado Shutdown: desativado
DBProxyInstanceName	String	gos787jog2wk0ye1****	O nome da instância de proxy.
DBProxyInstanceSize	String	4/8	As especificações da instância de proxy. Este parâmetro está disponível apenas para instâncias ApsaraDB RDS for PostgreSQL. Formato: Número de núcleos/Capacidade de memória. Por exemplo, o valor 4/8 indica que a instância de proxy possui 4 núcleos e 8 GB de memória.
DBProxyEngineType	String	normal	Um parâmetro interno. Não é necessário especificar este parâmetro.
DBProxyConnectStringItems	Array of DBProxyConnectStringItems		Um array com as informações sobre o endpoint de proxy criado para a instância.
DBProxyConnectStringItems
DBProxyConnectStringNetWorkType	String	2	O tipo de rede do proxy de banco de dados. Valores válidos: 0: Internet 1: rede clássica 2: VPC (virtual private cloud)
DBProxyConnectStringNetType	String	InnerString	O tipo de rede do endpoint de proxy. Valores válidos: InnerString: rede interna OuterString: Internet
DBProxyVpcInstanceId	String	rm-bp145737x5**131161274792**	O ID da instância de proxy.
DBProxyEndpointName	String	gos787jog2wk0ye1****	O nome do terminal de proxy ao qual o endpoint de proxy pertence.
DBProxyEndpointId	String	20****	O ID do terminal de proxy ao qual o endpoint de proxy pertence.
DBProxyConnectStringPort	String	3306	O número de porta associado ao endpoint de proxy.
DBProxyConnectString	String	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com	O endpoint do terminal de proxy.
DbProxyEndpointItems	Array of DbProxyEndpointItems		Um array com as informações sobre o terminal de proxy.
DbProxyEndpointItems
DbProxyEndpointAliases	String	proxy-test	A descrição do terminal de proxy.
DbProxyEndpointName	String	gos787jog2wk0ye1****	O ID do terminal de proxy.
DbProxyEndpointType	String	RWSplit	O tipo do terminal de proxy. Valores válidos: RWSplit: terminal de proxy padrão Custom: terminal de proxy personalizado
DbProxyReadWriteMode	String	ReadWrite	Os atributos de leitura e gravação do terminal de proxy. ReadWrite: O terminal de proxy aceita requisições de leitura e gravação. ReadOnly: O terminal de proxy aceita apenas requisições de leitura.
ResourceGroupId	String	rg-acfmy*****	O ID do grupo de recursos.

Exemplos

Exemplos de requisição

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

Exemplos de resposta bem-sucedida

XML format

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

<DescribeDBProxyResponse>
    <DBProxyInstanceName>gos787jog2wk0ye1****</DBProxyInstanceName>
    <DBProxyInstanceCurrentMinorVersion>1.13.11</DBProxyInstanceCurrentMinorVersion>
    <DBProxyServiceStatus>Startup</DBProxyServiceStatus>
    <DBProxyInstanceNum>1</DBProxyInstanceNum>
    <DBProxyInstanceLatestMinorVersion>1.13.12</DBProxyInstanceLatestMinorVersion>
    <RequestId>909A69EE-71C8-4417-A0B9-FF085407E1E3</RequestId>
    <DbProxyEndpointItems>
        <DbProxyEndpointItems>
            <DbProxyEndpointName>gos787jog2wk0ye1****</DbProxyEndpointName>
            <DbProxyEndpointAliases>proxy-test</DbProxyEndpointAliases>
            <DbProxyEndpointType>RWSplit</DbProxyEndpointType>
            <DbProxyReadWriteMode>ReadWrite</DbProxyReadWriteMode>
        </DbProxyEndpointItems>
    </DbProxyEndpointItems>
    <DBProxyConnectStringItems>
        <DBProxyConnectStringItems>
            <DBProxyConnectString>gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
            <DBProxyEndpointId>209090</DBProxyEndpointId>
            <DBProxyEndpointName>gos787jog2wk0ye1****</DBProxyEndpointName>
            <DBProxyConnectStringNetWorkType>2</DBProxyConnectStringNetWorkType>
            <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
            <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
            <DBProxyVpcInstanceId>rm-bp145737x5****131161274792****</DBProxyVpcInstanceId>
        </DBProxyConnectStringItems>
    </DBProxyConnectStringItems>
    <DBProxyInstanceStatus>Running</DBProxyInstanceStatus>
    <DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>

JSON format

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

{
  "DBProxyInstanceName" : "gos787jog2wk0ye1****",
  "DBProxyInstanceCurrentMinorVersion" : "1.13.11",
  "DBProxyServiceStatus" : "Startup",
  "DBProxyInstanceNum" : 1,
  "DBProxyInstanceLatestMinorVersion" : "1.13.12",
  "RequestId" : "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "DbProxyEndpointItems" : {
    "DbProxyEndpointItems" : [ {
      "DbProxyEndpointName" : "gos787jog2wk0ye1****",
      "DbProxyEndpointAliases" : "proxy-test",
      "DbProxyEndpointType" : "RWSplit",
      "DbProxyReadWriteMode" : "ReadWrite"
    } ]
  },
  "DBProxyConnectStringItems" : {
    "DBProxyConnectStringItems" : [ {
      "DBProxyConnectString" : "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
      "DBProxyEndpointId" : 209090,
      "DBProxyEndpointName" : "gos787jog2wk0ye1****",
      "DBProxyConnectStringNetWorkType" : 2,
      "DBProxyConnectStringNetType" : "InnerString",
      "DBProxyConnectStringPort" : "3306",
      "DBProxyVpcInstanceId" : "rm-bp145737x5****131161274792****"
    } ]
  },
  "DBProxyInstanceStatus" : "Running",
  "DBProxyInstanceType" : "2"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.	O erro foi retornado porque o valor do parâmetro DBInstanceName é inválido. Verifique se o valor é nulo ou uma string vazia.
403	IncorrectKindCode	Current custins kindCode does not support this operation.	O erro foi retornado porque a configuração da instância não é compatível com esta operação. Verifique a configuração da instância.
403	IncorrectDBInstanceType	The database instance type does not support the operation.	O erro foi retornado porque esta operação não é compatível com o mecanismo de banco de dados em execução na instância.

Para obter a lista de códigos de erro, acesse o API Error Center.