DescribeNetworkChannel - PolarDB: Central de Documentação do Alibaba Cloud

Consulta canais de rede.

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

polardb:DescribeNetworkChannel

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************
DBClusterId	string	Sim	O ID do cluster de origem.	pc-*************
ChannelName	string	Não	O nome do canal.	ch4
VpcId	string	Não	O ID da virtual private cloud (VPC) que contém o endpoint.	vpc-bp1qpo0kug3a20qqe****
RegionId	string	Não	O ID da região.	cn-hangzhou
ClientToken	string	Não	Um token de cliente que garante a idempotência da solicitação. Este valor é gerado pelo cliente e deve ser único para cada solicitação. O token diferencia maiúsculas de minúsculas e pode ter até 64 caracteres ASCII.	6000170000591aed949d0f54a343f1a4233c1e7d1c5******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ChannelInfos	array<object>	Uma lista de canais de rede.
	object	Os detalhes de um canal de rede.
ChannelName	string	O nome do canal.	ch4
DBClusterId	string	O ID do cluster de origem.	pc-*************
Notes	string	As observações sobre o canal.	test update
RegionId	string	O ID da região.	cn-hangzhou
TargetDBClusterId	string	O ID do cluster de destino.	pc-*************
TargetIp	string	O endereço IP do cluster de destino.	33...240
TargetPort	string	A porta do cluster de destino.	3389
TargetType	string	O tipo do cluster de destino.	polardb_for_postgresql
VpcId	string	O ID da VPC que contém o endpoint.	vpc-2ze13g2c6j7j2jl*******
RequestId	string	O ID da solicitação.	925B84D9-CA72-432C-95CF-738C22******

Exemplos

Resposta de sucesso

JSON formato

{
  "ChannelInfos": [
    {
      "ChannelName": "ch4",
      "DBClusterId": "pc-*************\n",
      "Notes": "test update",
      "RegionId": "cn-hangzhou",
      "TargetDBClusterId": "pc-*************\n",
      "TargetIp": "33.*.*.240",
      "TargetPort": "3389",
      "TargetType": "polardb_for_postgresql",
      "VpcId": "vpc-2ze13g2c6j7j2jl*******"
    }
  ],
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.