Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway dedicado (V2)/ Gestión de nombres de dominio/ Modificación de un nombre de dominio
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Modificación de un nombre de dominio

Función

Esta API se utiliza para modificar la configuración de un nombre de dominio enlazado a un grupo de API.

URI

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

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

Sí

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.

group_id

Sí

String

ID de grupo de API.

domain_id

Sí

String

ID de dominio.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token.
Tabla 3 Parámetros de body de solicitud

Parámetro

Obligatorio

Tipo

Descripción

min_ssl_version

Sí

String

Versión mínima de SSL. Se admiten TLS 1.1 y TLS 1.2.

Predeterminado: TLSv1.1

Valores de enumeración:

  • TLSv1.1

  • TLSv1.2

is_http_redirect_to_https

No

Boolean

Si se debe habilitar la redirección HTTP a HTTPS. El valor false significa deshabilitar y true significa habilitar. El valor predeterminado es false.

Predeterminado: false

Parámetros de respuesta

Código de estado: 201

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

url_domain

String

Nombre de dominio personalizado.

id

String

ID de dominio.

status

Integer

Estado de resolución de CNAME.

  • 1: not resolved

  • 2: resolving

  • 3: resolved

  • 4: resolution failed

Valores de enumeración:

  • 1

  • 2

  • 3

  • 4

min_ssl_version

String

Versión mínima de SSL compatible.

is_http_redirect_to_https

Boolean

Si se debe habilitar la redirección HTTP a HTTPS. El valor false significa deshabilitar y true significa habilitar. El valor predeterminado es false.

Predeterminado: false

Código de estado: 400

Tabla 5 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

{
  "min_ssl_version" : "TLSv1.2"
}

Ejemplo de respuestas

Código de estado: 201

Created

{
  "id" : "0a515af69f4e4dcca84fbf85f68c0e27",
  "url_domain" : "www.example.com",
  "status" : 3,
  "min_ssl_version" : "TLSv1.2",
  "is_http_redirect_to_https" : false
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.3474",
  "error_msg" : "The API group ID in the URL does not match the API group to which the URL domain has been bound"
}

Código de estado: 401

Unauthorized

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

Código de estado: 403

Forbidden

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

Código de estado: 404

Not Found

{
  "error_code" : "APIG.3020",
  "error_msg" : "The URL domain does not exist"
}

Código de estado: 500

Internal Server Error

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

Códigos de estado

Código de estado

Descripción

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.