ListGateway - Platform For AI: Central de Documentação do Alibaba Cloud

Lista gateways privados.

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

eas:ListGateway

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /api/v2/gateways HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GatewayId	string	Não	O ID do gateway privado. Você pode obter o ID a partir do campo private_gateway_id na resposta da operação ListResources.	gw-1uhcqmsc7x22******
PageNumber	integer	Não	O número da página da lista de gateways a ser retornada. O valor padrão é 1.	1
PageSize	integer	Não	O número de gateways a serem retornados em cada página. O valor padrão é 100.	100
GatewayName	string	Não	O alias do gateway privado.	mygateway1
ResourceName	string	Não	O ID do grupo de recursos. Você pode obter o ID a partir do campo ResourceId na resposta da operação ListResources.	eas-r-4gt8twzwllfo******
InternetEnabled	boolean	Não	Especifica se o acesso pela rede pública deve ser ativado.	true
Status	string	Não	O status do gateway.	Running
ChargeType	string	Não	O método de cobrança. Valores válidos: PostPaid : Pay-as-you-go. PrePaid : Assinatura.	PrePaid
Sort	string	Não	O campo pelo qual ordenar. Valores válidos: Status : Status. ChargeType : Método de cobrança. CreateTime : Hora de criação. UpdateTime : Hora de atualização. InternetEnabled : Acesso à rede pública. GatewayType : Tipo de gateway. GatewayName : Nome do gateway.	CreateTime
Order	string	Não	A ordem de classificação. Valores válidos: asc : Ascendente. desc : Descendente.	asc
GatewayType	string	Não	O tipo do gateway. Valores válidos: FullyManaged : Gateway dedicado totalmente gerenciado. Application : Gateway dedicado de aplicação.	Application
Label	object	Não	Filtrar por tag.
	string	Não	A tag pela qual filtrar, no formato {"key":"value"}. Você pode definir o valor como null ou uma string vazia para filtrar apenas pela chave.	{"key1":"value1","key2":null}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
RequestId	string	O ID da solicitação.	40325405-579C-4D82****
Gateways	array<object>	A lista de gateways privados.
	array<object>	Os detalhes do gateway privado.
GatewayId	string	O ID do gateway privado.	gw-1uhcqmsc7x22******
GatewayName	string	O alias do gateway privado.	mygateway1
InstanceType	string	O tipo de instância utilizado pelo gateway privado.	2c4g
IntranetDomain	string	O endpoint da rede interna.	gw-1uhcqmsc7x22****-1801786532****-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
InternetEnabled	boolean	Indica se o acesso à rede pública está ativado.	true
InternetDomain	string	O endpoint da rede pública.	gw-1uhcqmsc7x22****-1801786532****.cn-wulanchabu.pai-eas.aliyuncs.com
CreateTime	string	A hora em que o gateway privado foi criado. A hora está em UTC.	2020-05-19T14:19:42Z
UpdateTime	string	A hora em que o gateway privado foi atualizado pela última vez. A hora está em UTC.	2021-02-24T11:52:17Z
Status	string	O status do gateway privado. Valores válidos: Creating : O gateway está sendo criado. Stopped : O gateway está parado. Failed : O gateway falhou. Running : O gateway está em execução. Deleted : O gateway foi excluído. Deleting : O gateway está sendo excluído. Waiting : O gateway está aguardando.	Running
Replicas	integer	O número de nós do gateway privado.	2
IsDefault	boolean	Indica se é o gateway privado padrão.	true
ChargeType	string	O método de cobrança. Valores válidos: PrePaid: Assinatura. PostPaid: Pay-as-you-go.	PostPaid
SSLRedirectionEnabled	boolean	Indica se o redirecionamento de HTTP para HTTPS está ativado.	true
IntranetEnabled	boolean	Indica se o acesso à rede interna está ativado.
Labels	array<object>	A lista de tags do gateway.
	object	O objeto de tag do gateway.
LabelKey	string	The key of the gateway tag.	key1
LabelValue	string	The value of the gateway tag.	value1
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	100
TotalCount	integer	O número total de gateways.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true,
      "IntranetEnabled": false,
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

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.