Consulta de aplicaciones vinculadas a una API
Función
Esta API se utiliza para consultar las aplicaciones que se han enlazado a una API especificada.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apps
|
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 |
No |
String |
ID de API. |
|
app_name |
No |
String |
Nombre de la aplicación. |
|
app_id |
No |
String |
ID de la aplicación. |
|
env_id |
No |
String |
ID de entorno. |
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. |
|
auths |
Array of ApiAuthInfo objects |
Lista de API. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID de registro de autorización. |
|
api_id |
String |
ID de API. |
|
api_name |
String |
Nombre de API. |
|
group_name |
String |
Nombre del grupo de API al que pertenece la API. |
|
api_type |
Integer |
Tipo de API. |
|
api_remark |
String |
Descripción de API. |
|
env_id |
String |
ID del entorno en el que se ha autorizado a una aplicación para llamar a la API. |
|
auth_role |
String |
Autorizador. |
|
auth_time |
String |
Tiempo de autorización. |
|
app_name |
String |
Nombre de la aplicación. |
|
app_remark |
String |
Descripción de la aplicación. |
|
app_type |
String |
Tipo de aplicación. El valor predeterminado es apig. Otros tipos no son compatibles actualmente. Valores de enumeración:
|
|
app_creator |
String |
Creador de la aplicación.
|
|
publish_id |
String |
ID de registro de publicación de API. |
|
group_id |
String |
ID del grupo de API al que pertenece la API. |
|
auth_tunnel |
String |
Tipo de canal de autorización.
El valor predeterminado es NORMAL. Este parámetro no se admite actualmente. Valores de enumeración:
|
|
auth_whitelist |
Array of strings |
Lista blanca para el canal verde. |
|
auth_blacklist |
Array of strings |
Lista negra para el canal verde. |
|
visit_param |
String |
Parámetros de acceso. |
|
roma_app_type |
String |
Tipo de aplicación de ROMA.
Actualmente, este parámetro no es compatible. |
|
env_name |
String |
Nombre del entorno en el que se ha autorizado a la aplicación para llamar a la API. |
|
app_id |
String |
ID de la aplicació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,
"auths" : [ {
"api_id" : "5f918d104dc84480a75166ba99efff21",
"app_name" : "app_demo",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name" : "RELEASE",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"group_name" : "api_group_001",
"api_type" : 1,
"api_name" : "Api_http",
"app_id" : "356de8eb7a8742168586e5daf5339965",
"auth_time" : "2020-08-04T04:02:22Z",
"app_creator" : "USER",
"id" : "dd29b33ae4394e3b924b582c6b40880b",
"api_remark" : "Web backend API",
"auth_role" : "PROVIDER",
"app_type" : "apig",
"auth_tunnel" : "NORMAL"
} ]
}
Código de estado: 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:app_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.
