Autorización de aplicaciones
Función
Una aplicación no puede acceder a ninguna API después de haber sido creada. Para acceder a una API en un entorno específico, vincule la aplicación a la API en el 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}/app-auths
|
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 |
|---|---|---|---|
|
env_id |
Sí |
String |
ID del entorno en el que se autorizarán las aplicaciones. |
|
app_ids |
Sí |
Array of strings |
ID de aplicaciones. |
|
api_ids |
Sí |
Array of strings |
Lista de las API. |
Parámetros de respuesta
Código de estado: 201
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
auths |
Array of ApiAuthRelations objects |
Registros de autorización de aplicaciones. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
api_id |
String |
ID de API. |
|
auth_result |
AuthResult object |
Resultado de la autorización. |
|
auth_time |
String |
Tiempo de autorización. |
|
id |
String |
ID de registro de autorización. |
|
app_id |
String |
ID de la aplicación. |
|
auth_role |
String |
Autorizador.
|
|
auth_tunnel |
String |
Tipo de canal de autorización.
El valor predeterminado es NORMAL. Este parámetro no se admite actualmente. |
|
auth_whitelist |
Array of strings |
Lista blanca para el canal verde. |
|
auth_blacklist |
Array of strings |
Lista negra para el canal verde. |
|
visit_params |
String |
Parámetros de acceso. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
status |
String |
Resultado de la autorización.
|
|
error_msg |
String |
Mensaje de error. |
|
error_code |
String |
Código de error. |
|
api_name |
String |
Nombre de la API para la que falla la autorización. |
|
app_name |
String |
Nombre de la aplicación que no está autorizada. |
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
Autorización de una aplicación para invocar a una API
{
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"app_ids" : [ "356de8eb7a8742168586e5daf5339965" ],
"api_ids" : [ "5f918d104dc84480a75166ba99efff21" ]
}
Ejemplo de respuestas
Código de estado: 201
Creado
{
"auths" : [ {
"api_id" : "5f918d104dc84480a75166ba99efff21",
"auth_result" : {
"status" : "SUCCESS"
},
"auth_time" : "22020-08-04T04:02:22.482227344Z",
"id" : "dd29b33ae4394e3b924b582c6b40880b",
"app_id" : "356de8eb7a8742168586e5daf5339965",
"auth_role" : "PROVIDER",
"auth_tunnel" : "NORMAL"
} ]
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:api_ids. 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.3004",
"error_msg" : "App 356de8eb7a8742168586e5daf5339965 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.