Consulta de las API no vinculadas con una aplicación
Función
Esta API se utiliza para consultar las API autodesarrolladas a las que no se ha vinculado una aplicación en un entorno específico.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis
|
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á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 |
|
app_id |
Sí |
String |
ID de la aplicación. |
|
env_id |
Sí |
String |
ID de entorno. |
|
group_id |
No |
String |
ID de grupo de API. |
|
api_id |
No |
String |
ID de API. |
|
api_name |
No |
String |
Nombre de la API. |
|
tags |
No |
String |
Etiqueta de API. Se pueden especificar varias etiquetas de API. La relación entre varios valores de parámetro es OR. Si no se especifica este parámetro, no se especifica ninguna etiqueta de filtrado. Si este parámetro se establece en #no_tags#, se filtran las API sin etiquetas. Mínimo: 0 Máximo: 128 |
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á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. |
|
apis |
Array of ApiOutline objects |
Lista de API. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
auth_type |
String |
Modo de autenticación de API. |
|
run_env_name |
String |
Nombre del entorno en el que se ha publicado la API. |
|
group_name |
String |
Nombre del grupo de API al que pertenece la API. |
|
publish_id |
String |
ID del registro de publicación. |
|
group_id |
String |
ID del grupo de API al que pertenece la API. |
|
name |
String |
Nombre de la API. |
|
remark |
String |
Descripción de API. |
|
run_env_id |
String |
ID del entorno en el que se ha publicado la API. |
|
id |
String |
ID de API. |
|
req_uri |
String |
Dirección de solicitud de API. |
|
tags |
Array of strings |
Etiquetas vinculadas a la API. La cuota predeterminada es 10. Póngase en contacto con el soporte técnico para ajustar la cuota. Mínimo: 1 Máximo: 128 Longitud del arreglo: 0 - 10 |
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
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 2,
"size" : 2,
"apis" : [ {
"auth_type" : "APP",
"run_env_name" : "",
"group_name" : "api_group_001",
"publish_id" : "",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"name" : "Api_function",
"remark" : "FunctionGraph backend API",
"run_env_id" : "",
"id" : "abd9c4b2ff974888b0ba79be7e6b2763",
"req_uri" : "/test/function"
}, {
"auth_type" : "APP",
"run_env_name" : "RELEASE",
"group_name" : "APIGroup_d3da",
"publish_id" : "ca2631e233a74a758744ae1e19cc5ad7",
"group_id" : "6acd94abe58747ee8a73b10c70817bac",
"name" : "API_test",
"remark" : "FunctionGraph backend API",
"run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"id" : "11cbec3a7a8345ca981b86d161bc436e",
"req_uri" : "/appcode"
} ]
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:api_name. 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 |
|---|---|
|
200 |
Aceptar |
|
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.
