Consulta de políticas de control de acceso vinculadas a una API
Función
Esta API se utiliza para consultar las políticas de control de acceso que se han enlazado a una API especificada.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-acls
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. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
api_id |
Sí |
String |
ID de API. |
env_id |
No |
String |
ID de entorno. |
env_name |
No |
String |
Nombre del entorno. |
acl_id |
No |
String |
ID de política de control de acceso. |
acl_name |
No |
String |
Nombre de política de control de acceso. |
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 de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
size |
Integer |
Longitud de la lista de recursos devuelta. |
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
acls |
Array of ApiBindAclInfo objects |
Lista de políticas de control de acceso. |
Parámetro |
Tipo |
Descripción |
---|---|---|
acl_id |
String |
ID de política de control de acceso. |
acl_name |
String |
Nombre de política de control de acceso. |
entity_type |
String |
Tipo de objeto. Valores de enumeración:
|
acl_type |
String |
Tipo de control de acceso.
Valores de enumeración:
|
acl_value |
String |
Objetos de control de acceso. |
env_id |
String |
ID de entorno efectivo. |
env_name |
String |
Nombre efectivo del entorno. |
bind_id |
String |
ID de registro de vinculación. |
bind_time |
String |
Hora de vinculación. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
Ninguna
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 1, "size" : 1, "acls" : [ { "acl_id" : "7eb619ecf2a24943b099833cd24a01ba", "acl_name" : "acl_demo", "entity_type" : "IP", "acl_type" : "PERMIT", "acl_value" : "192.168.1.5,192.168.10.1", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "bind_id" : "332c5db1458a477b89b2ea741fec94a3", "bind_time" : "2020-08-04T08:58:03Z" } ] }
Código de estado: 400
Bad Request
{ "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:acl_name. Please refer to the support documentation" }
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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 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 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.