DescribeDBInstanceNetInfo - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta as informações de rede de uma instância do ApsaraDB for Tair.

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

kvstore:DescribeDBInstanceNetInfo

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	r-bp1zxszhcgatnx****
NetType	string	Não	O tipo de rede.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
InstanceNetworkType	string	O tipo de rede. Valores válidos: CLASSIC: Rede Clássica. VPC: VPC.	CLASSIC
RequestId	string	O ID da solicitação.	FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B
NetInfoItems	object	Detalhes sobre as conexões de rede da instância.
InstanceNetInfo	array<object>	Uma matriz de detalhes de conexão de rede da instância.
	object	Os detalhes de uma conexão de rede.
DirectConnection	integer	Indicates whether the address is for a direct connection. Valid values: 0: The address is not for a direct connection. 1: The address is for a direct connection.	0
VSwitchId	string	The ID of the vSwitch.	vsw-bp1e7clcw529l773d****
DBInstanceNetType	string	The network type. Valid values: 0: public network. 1: Classic Network. 2: VPC network.	1
Upgradeable	string	The remaining validity period of the Classic Network connection string, in seconds. Nota A value of 0 indicates that the connection string does not expire.	0
ExpiredTime	string	The validity period of the Classic Network connection string, in seconds.	5183778
ConnectionString	string	The connection string of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
IPType	string	The network type of the IP address. Valid values: Public: public network. Inner: Classic Network. Private: VPC network.	Inner
VPCInstanceId	string	The ID of the instance associated with the VPC.	r-bp1ky7j6qc7umk****
Port	string	The service port of the instance.	6379
VPCId	string	The ID of the VPC to which the instance belongs.	vpc-bp1nme44gek34slfc****
IPAddress	string	The IP address.	172.16.49.***
IsSlaveProxy	integer	A value of 1 indicates that this network address is for a replica node in the standby zone. Nota This address is returned only when multi-zone read/write splitting is enabled for the instance.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "InstanceNetworkType": "CLASSIC",
  "RequestId": "FC77D4E1-2A7C-4F0B-A4CC-CE0B9C314B9B",
  "NetInfoItems": {
    "InstanceNetInfo": [
      {
        "DirectConnection": 0,
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "DBInstanceNetType": "1",
        "Upgradeable": "0",
        "ExpiredTime": "5183778",
        "ConnectionString": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IPType": "Inner",
        "VPCInstanceId": "r-bp1ky7j6qc7umk****",
        "Port": "6379",
        "VPCId": "vpc-bp1nme44gek34slfc****",
        "IPAddress": "172.16.49.***",
        "IsSlaveProxy": 1
      }
    ]
  }
}

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.