Consulta de la lista de reglas de control de acceso de geolocalización
Función
Esta API se utiliza para consultar la lista de reglas de control de acceso de geolocalización.
URI
GET /v1/{project_id}/waf/policy/{policy_id}/geoip
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
policy_id |
Sí |
String |
ID de política. Se puede obtener llamando a la API ListPolicy. |
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. |
page |
No |
Integer |
Número de página de los datos a devolver durante la consulta de paginación. El valor varía de 0 a 100000. El valor predeterminado es 1, que indica que se devuelven los datos de la primera página. Predeterminado: 1 |
pagesize |
No |
Integer |
Número de resultados en cada página durante la consulta de paginación. El valor varía de 1 a 100. El valor predeterminado es 10, lo que indica que cada página contiene 10 resultados. Predeterminado: 10 |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
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). |
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
total |
Integer |
Número de ubicaciones geográficas bloqueadas en la política. |
items |
Array of GeOIpItem objects |
Lista de las ubicaciones bloqueadas en las reglas de control de acceso de geolocalización |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de la regla. |
geoip |
String |
Códigos para regiones que se pueden utilizar en una regla de control de acceso de geolocalización. \n CN: China, AB2: Fuera de China continental, AB: Fuera de China continental, Hong Kong, Macao y Taiwán, CA: Canadá, US: Los Estados Unidos, AU: Australia, IN: India, JP: Japón, UK: Reino Unido, FR: Francia, DE: Alemania, BR: Brasil, Ukraine: Ucrania, North Korea: Corea del Norte, The Republic of Korea: La República de Corea, Iran: Irán, Cuba: Cuba, Sultan: Sudán, Syria: Siria, Pakistan: Pakistán, Palestine Palestina, Israel Israel, Iraq: Iraq, Afghanistan: Afganistán, Libya: Libia, Turkey: Turquía, Thailand: Tailandia, Singapore: Singapur, South Africa: Sudáfrica, Mexico: México, Peru: Perú, Indonesia: Indonesia, GD Guangdong, FJ: Fujian, JL: Jilin, LN: Liaoning, TW: Taiwan (China), GZ: Guizhou, AH: Anhui, HL: Heilongjiang, HA: Henan, SC: Sichuan, HE: Hebei, YN: Yunnan, HB: Hubei, HI: Hainan, QH: Qinghai, HN: Hunan, JX: Jiangxi, SX: Shanxi, SN: Shaanxi, ZJ: Zhejiang, GS: Gansu, JS: Jiangsu, SD: Shandong, BJ: Beijing, SH: Shanghai, TJ: Tianjin, CQ: Chongqing, MO: Macao (China), HK: Hong Kong (China), NX: Ningxia, GX: Guangxi, XJ: Xinjiang, XZ: Tibet, NM: Mongolia interior |
white |
Integer |
Acción protectora: \n - 0: Block \n - 1: Allow \n - 2: Log only |
timestamp |
Long |
Marca de tiempo de creación de reglas |
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 estad: 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
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?enterprise_project_id=0
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 1, "items" : [ { "id" : "06f07f6c229141b9a4a78614751bb687", "policyid" : "2abeeecefb9840e6bf05efbd80d0fcd7", "policyname" : "policy_LOow3V5l", "timestamp" : 1636340038062, "status" : 1, "geoip" : "GD", "white" : 1, "geoTagList" : [ "GD" ] } ] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Error de solicitud. |
401 |
Permisos de token insuficientes. |
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.