Vinculación de una política de control de acceso a una API
Función
Esta API se utiliza para vincular una política de control de acceso a una API especificada.
Puede vincular diferentes políticas de control de acceso a una API en diferentes entornos, pero solo puede vincular una política de control de acceso a la API en cada entorno.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
project_id | Sí | String | ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
instance_id | Sí | String | ID de gateway, que se puede obtener de la información de gateway en la consola de APIG. |
Parámetros de solicitud
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
X-Auth-Token | Sí | String | Token de usuario. Se puede obtener invocando 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ámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
acl_id | No | String | ID de política de control de acceso. |
publish_ids | No | Array of strings | ID de registro de publicación de API. |
Parámetros de respuesta
Código de estado: 201
Parámetro | Tipo | Descripción |
|---|---|---|
acl_bindings | Array of AclApiBindingInfo objects | Registros de enlace de políticas de control de acceso. |
Parámetro | Tipo | Descripción |
|---|---|---|
id | String | ID de registro de vinculación. |
api_id | String | ID de API. |
env_id | String | ID de entorno. |
acl_id | String | ID de política de control de acceso. |
create_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. |
Ejemplo de las solicitudes
Vinculación de una política de control de acceso a una API
{
"acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
"publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
} Ejemplo de respuestas
Código de estado: 201
Creado
{
"acl_bindings" : [ {
"id" : "332c5db1458a477b89b2ea741fec94a3",
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
"create_time" : "2020-08-04T08:58:03.001228747Z"
} ]
} Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:acl_id. Please refer to the support documentation"
} Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3006",
"error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
} Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de estado
Código de estado | Descripción |
|---|---|
201 | Creado |
400 | Error en la solicitud |
401 | Sin autorización |
403 | Prohibido |
404 | No se ha encontrado |
500 | Error del servidor interno |
Códigos de error
Consulte Códigos de error.
