Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ API Gateway/ Referência de API/ APIs de gateway dedicadas (V2)/ Gerenciamento de nome de domínio/ Vinculação de um nome de domínio
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Vinculação de um nome de domínio

Função

Um nome de domínio definido pelo usuário entra em vigor somente após a adição de um conjunto de registros A. Para obter detalhes, consulte a seção "Adição de um conjunto de registros" no Guia de usuário do Domain Name Service. Um grupo de APIs pode ser vinculado a no máximo cinco nomes de domínio. Depois de vincular um nome de domínio a um grupo de APIs, as APIs no grupo podem ser chamadas usando o nome de domínio.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.

group_id

Sim

String

ID do grupo da API.

Parâmetros de solicitação

Tabela 2 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.
Tabela 3 Parâmetros de corpo de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

min_ssl_version

Não

String

Versão SSL mínima. TLS 1.1 e TLS 1.2 são suportados.

Padrão: TLSv1.1

Valores de enumeração:

  • TLSv1.1

  • TLSv1.2

is_http_redirect_to_https

Não

Boolean

Se deve habilitar o redirecionamento HTTP para HTTPS. O valor false significa desabilitar e true significa habilitar. O valor padrão é false.

Padrão: false

url_domain

Sim

String

Nomes de domínio personalizados. Ele pode conter no máximo 255 caracteres e deve estar em conformidade com as especificações de nome de domínio.

Parâmetros de resposta

Código de status: 201

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

url_domain

String

Nomes de domínio personalizados.

id

String

ID do domínio.

status

Integer

Status da resolução CNAME

  • 1: não resolvido

  • 2: resolvendo

  • 3: resolvido

  • 4: resolução falhou

Valores de enumeração:

  • 1

  • 2

  • 3

  • 4

min_ssl_version

String

Versão mínima SSL suportada.

is_http_redirect_to_https

Boolean

Se deve habilitar o redirecionamento HTTP para HTTPS. O valor false significa desabilitar e true significa habilitar. O valor padrão é false.

Padrão: false

Código de status: 400

Tabela 5 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 401

Tabela 6 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 403

Tabela 7 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 404

Tabela 8 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 9 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitações

{
  "url_domain" : "www.company.com"
}

Exemplo de respostas

Código de status: 201

Criado

{
  "url_domain" : "www.company.com",
  "id" : "c5e0d5ba62a34d26ad5c709ae22c1a17",
  "status" : 3,
  "min_ssl_version" : "TLSv1.1",
  "is_http_redirect_to_https" : false
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2024",
  "error_msg" : "Invalid URL domain name"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 404

Não encontrado

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status

Descrição

201

Criado

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.