Vinculación de un nombre de dominio
Función
Los nombres de dominio se definen por el usuario y solo tienen efecto después de agregar los registros CNAME para dirigir los nombres de dominio a los nombres de subdominio de los grupos de API. Para obtener más información, consulte Adición de un conjunto de registro de CNAME.
Un grupo de API puede estar enlazado a un máximo de cinco nombres de dominio. Después de vincular un nombre de dominio a un grupo de API, se puede llamar a las API del grupo mediante el nombre de dominio.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
POST |
/v1.0/apigw/api-groups/{group_id}/domains |
En la siguiente tabla se muestra el parámetro en el URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
group_id |
Sí |
String |
ID de grupo de API |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
url_domain |
Sí |
String |
Nombre de dominio Un nombre de dominio consta de un máximo de 255 caracteres y debe cumplir con las especificaciones del nombre de dominio. |
Ejemplo de solicitud:
{ "url_domain": "www.MyCompany.com" }
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de dominio |
url_domain |
String |
Nombre de dominio |
status |
Integer |
Estado de resolución de CNAME, que puede ser:
|
Ejemplo de respuesta:
{ "id": "c5e0d5ba62a34d26ad5c709ae22c1a17", "url_domain": "www.MyCompany.com", "status": 3 }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |