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

Lista os nomes de domínio personalizados para um gateway privado.

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:ListGatewayDomains

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /api/v2/gateways/{ClusterId}/{GatewayId}/domains HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	A região onde o gateway privado está localizado.	cn-shanghai
GatewayId	string	Sim	O ID do gateway privado. Para obter esse ID, consulte o campo GatewayId na resposta da operação de API ListGateway.	gw-1uhcqmsc7x22******

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os resultados retornados.
RequestId	string	O ID da solicitação.	40325405-579C-4D82****
Message	string	A mensagem retornada para a solicitação.	Successfully get custom domains
CustomDomains	array<object>	A lista de nomes de domínio personalizados.
	object	Os detalhes do nome de domínio personalizado.
Type	string	O tipo do nome de domínio. Valores válidos: intranet : Endpoint interno na mesma região. internet : Nome de domínio público.	intranet
CertificateId	string	O ID do certificado SSL anexado ao nome de domínio. Para obter o ID do certificado, faça upload ou compre um certificado no console do Digital Certificate Management Service.	1473**25
Domain	string	O nome de domínio personalizado.	test.com
CertificateName	string	O nome do certificado SSL.	cert-9955038
CertificateStartDate	string	A data de emissão do certificado.	2018-07-13
CertificateEndDate	string	A data de expiração do certificado.	2023-10-25
CreateTime	string	A hora em que o nome de domínio foi criado.	2020-05-19T14:19:42Z
UpdateTime	string	A hora em que o nome de domínio foi atualizado pela última vez.	2021-05-19T14:19:42Z
CertificateStatus	string	O status do certificado. Valores válidos: Succeeded : A operação foi bem-sucedida. Failed : A operação falhou. Attaching : O certificado está sendo anexado. Deleting : O nome de domínio está sendo excluído.	Succeeded

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully get custom domains",
  "CustomDomains": [
    {
      "Type": "intranet",
      "CertificateId": "1473**25",
      "Domain": "test.com",
      "CertificateName": "cert-9955038",
      "CertificateStartDate": "2018-07-13",
      "CertificateEndDate": "2023-10-25",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-05-19T14:19:42Z",
      "CertificateStatus": "Succeeded"
    }
  ]
}

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.