Adición de un nombre de dominio a una instancia WAF dedicada
Función
Esta API se utiliza para agregar un nombre de dominio a una instancia WAF dedicada.
URI
POST /v1/{project_id}/premium-waf/host
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enterprise_project_id |
No |
String |
ID del proyecto de empresa. Se puede obtener mediante el llamado API ListEnterpriseProject de EPS. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
certificateid |
No |
String |
ID del certificado. Se puede obtener llamando a la API ListCertificates. \n - Este parámetro no es necesario cuando el protocolo cliente es HTTP. \n - Este parámetro es obligatorio cuando el protocolo cliente es HTTPS. |
certificatename |
No |
String |
Nombre del certificado. \n - Este parámetro no es necesario cuando el protocolo cliente es HTTP. \n - Este parámetro es obligatorio cuando el protocolo cliente es HTTPS. |
hostname |
Sí |
String |
Nombre de dominio protegido o dirección IP (puerto permitido) |
proxy |
Yes |
Boolean |
Si se utiliza un proxy para el nombre de dominio |
policyid |
No |
String |
ID de la política utilizada inicialmente para el nombre de dominio. Se puede obtener llamando a la API ListPolicy. |
server |
Sí |
Array of PremiumWafServer objects |
Configuración del servidor |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
front_protocol |
Sí |
String |
Protocolo del cliente Valores de enumeración:
|
back_protocol |
Sí |
String |
Protocolo de servidor Valores de enumeración:
|
address |
Sí |
String |
Dirección del servidor |
port |
Sí |
Integer |
Puerto del servidor |
type |
Sí |
String |
La dirección del servidor de origen es una dirección IPv4 o IPv6. Valores de enumeración:
|
vpc_id |
Sí |
String |
ID de VPC. Para obtener el ID de VPC, realice los siguientes pasos: ID de VPC. Realice los siguientes pasos para obtener el ID de VPC. \n 1. Inicie sesión en la consola WAF y elija Instance Management > Dedicated Engine > VPC/Subnet. El nombre de la VPC se encuentra en la columna VPC o Subnet. 2. Inicie sesión en la consola de VPC y haga clic en el nombre de VPC. En la página que se muestra, copie el ID en el área VPC Information. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de nombre de dominio |
policyid |
String |
ID de política |
hostname |
String |
ID de nombre de dominio |
domainid |
String |
ID de inquilino. |
projectid |
String |
ID del proyecto. |
protocol |
String |
Protocolo HTTP |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Mensaje de código de error |
Solicitudes de ejemplo
POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0 { "hostname" : "www.demo.com", "server" : [ { "front_protocol" : "HTTP", "back_protocol" : "HTTP", "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247", "type" : "ipv4", "address" : "x.x.x.x", "port" : 80 } ], "proxy" : false, "description" : "" }
Ejemplo de respuestas
Código de estado: 200
OK
{ "id" : "51a5649e52d341a9bb802044950969dc", "hostname" : "www.demo.com", "protocol" : "HTTP", "server" : [ { "address" : "x.x.x.x", "port" : 80, "type" : "ipv4", "weight" : 1, "front_protocol" : "HTTP", "back_protocol" : "HTTP", "vpc_id" : "cf6dbace-b36a-4d51-ae04-52a3319ae247" } ], "proxy" : false, "locked" : 0, "timestamp" : 1650596007113, "flag" : { "pci_3ds" : "false", "pci_dss" : "false" }, "description" : "", "policyid" : "1607df035bc847b582ce9c838c083b88", "domainid" : "d4ecb00b031941ce9171b7bc3386883f", "enterprise_project_id" : "0", "protect_status" : 1, "access_status" : 0, "web_tag" : "", "access_progress" : [ ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Solicitud no válida. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.