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.
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 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á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á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. |
Solicitudes de ejemplo
{
"acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
"publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
}
Ejemplo de respuestas
Código de estado: 201
Created
{
"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
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:acl_id. 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.3006",
"error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba 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 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.