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

Consulta a lista de nomes de domínio personalizados para um gateway dedicado.

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 resources.

*

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 dedicado está localizado.	cn-shanghai
GatewayId	string	Sim	O ID do gateway dedicado. Para obter o ID do gateway dedicado, consulte o campo GatewayId na resposta da operação 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	A resposta.
RequestId	string	O ID da solicitação.	40325405-579C-4D82****
Message	string	A mensagem de resposta.	Domínios personalizados obtidos com sucesso
CustomDomains	array<object>	A lista de nomes de domínio personalizados.
	object	Os detalhes do nome de domínio personalizado.
Type	string	O tipo de nome de domínio. Valores válidos: intranet : Nome de domínio interno. internet : Nome de domínio público.	intranet
CertificateId	string	O ID do certificado SSL vinculado ao nome de domínio. Obtenha o ID do certificado após fazer upload ou comprar um certificado no 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 no formato AAAA-MM-DD.	2018-07-13
CertificateEndDate	string	A data de expiração do certificado no formato AAAA-MM-DD.	2023-10-25
CreateTime	string	A hora em que o nome de domínio foi criado, no formato UTC e RFC 3339.	2020-05-19T14:19:42Z
UpdateTime	string	A hora em que o nome de domínio foi atualizado pela última vez, no formato UTC e RFC 3339.	2021-05-19T14:19:42Z
CertificateStatus	string	O status do certificado. Valores válidos: Succeeded : Bem-sucedido. Failed : Falha. Attaching : Vinculação em andamento. Deleting : Exclusão em andamento.	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.