Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway compartido (para usuarios existentes)/ Gestión de API/ Consulta de una lista de API

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Consulta de una lista de API

Función

Esta API se utiliza para consultar una lista de API para devolver detalles e información de publicación de las API. La información de backend de las API no se devolverá.

URI

La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.

**Tabla 1** Método de solicitud de HTTP/HTTPS y URI
Método de solicitud	URI
GET	/v1.0/apigw/apis[?page_size, page_no, id, name, group_id, req_protocol, req_method, req_uri, auth_type, env_id, type,status, tags]

Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
Las condiciones de consulta incluyen: ID, name, group_id, req_protocol, req_method, req_uri, auth_type, env_id, type, status, tags, page_size y page_no.

Solicitud

**Tabla 2** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
id	No	String	ID de API
name	No	String	Nombre de la API
group_id	No	String	ID del grupo de API al que pertenece la API
req_protocol	No	String	Solicitud de protocolo
req_method	No	String	Método de solicitud
req_uri	No	String	Ruta de solicitud
auth_type	No	String	Modo de autenticación de seguridad
env_id	No	String	ID del entorno en el que se ha publicado la API
type	No	Integer	Tipo de API
page_size	No	Integer	Número de registros mostrados en cada página. El valor predeterminado es 20 y el valor máximo es 500. Cuando el valor de page_size se establece en 0 se devuelven todas las API.
page_no	No	Integer	Número de página. El valor predeterminado es 1.
precise_search	No	String	Nombre del parámetro (name o req_uri) para la coincidencia exacta.

Respuesta

**Tabla 3** Descripción de parámetro
Parámetro	Tipo	Descripción
total	Integer	Número de API que coinciden con las condiciones de consulta
size	Integer	Longitud de la lista de API devuelta
apis	Dictionary	Lista de API

**Tabla 4** Descripción del parámetro de apis
Parámetro	Tipo	Descripción
id	String	ID de API
name	String	Nombre de la API
group_id	String	ID del grupo de API al que pertenece la API
group_name	String	Nombre del grupo de API al que pertenece la API
status	Integer	Estado de la API
type	Integer	Tipo de API
version	String	Versión de la API
req_protocol	String	Solicitud de protocolo
req_method	String	Método de solicitud
req_uri	String	Dirección de acceso
auth_type	String	Modo de autenticación de seguridad
auth_opt	Object	Parámetro del modo de autenticación de seguridad
authorizer_id	String	ID del autorizador personalizado de frontend
match_mode	String	Modo de coincidencia
register_time	Timestamp	Hora en que se creó la API
update_time	Timestamp	Hora de la última modificación de la API
remark	String	Descripción de la API
bakend_type	String	Tipo de backend
run_env_name	String	Nombre del entorno en el que se ha publicado la API
run_env_id	String	ID del entorno en el que se ha publicado la API
publish_id	String	ID del registro de publicación
arrange_necessary	Integer	Indica si se requiere orquestación.
cors	Bool	Indica si se admite CORS.
tag	String	Etiqueta de nombre de servicio, que debe descartarse
tags	[]String	Etiquetas de API
response_id	String	ID de la respuesta del gateway

**Tabla 5** Descripción del parámetro de auth_opt
Parámetro	Tipo	Descripción
app_code_auth_type	String	Indica si la autenticación AppCode está habilitada.

Ejemplo de respuesta:

{
  "total": 3,
  "size": 3,
  "apis": [
    {
      "name": "test",
      "type": 1,
      "version": "V0.0.1",
      "req_protocol": "HTTPS",
      "req_method": "GET",
      "req_uri": "/test/{project_id}",
      "auth_type": "APP",
      "auth_opt": {
        "app_code_auth_type": "DISABLE"
      },
      "tags": ["APIG-SN-test", "test"],
      "cors": false,
      "match_mode": "NORMAL",
      "backend_type": "HTTP",
      "group_id": "f71f69876f90456ca6fd18ed012fdc11",
      "id": "81efcfd94b8747a0b21e8c04144a4e8c",
      "status": 1,
      "arrange_necessary": 2,
      "register_time": "2018-08-15T03:41:11Z",
      "update_time": "2018-08-15T03:41:11Z",
      "group_name": "group0002"
    },
    {
      "name": "bbbbb",
      "type": 1,
      "version": "0.0.1",
      "req_protocol": "HTTPS",
      "req_method": "GET",
      "req_uri": "/test002",
      "auth_type": "APP",
      "auth_opt": {
        "app_code_auth_type": "DISABLE"
      },
      "tags": ["APIG-SN-test", "test"],
      "cors": false,
      "match_mode": "NORMAL",
      "backend_type": "MOCK",
      "remark": "aaa",
      "group_id": "70f1b578da9b4dfe889b4c33d1b995c2",
      "id": "91c26288acea4448be205265d77dae22",
      "status": 1,
      "arrange_necessary": 2,
      "register_time": "2018-07-27T11:54:24Z",
      "update_time": "2018-07-27T11:54:24Z",
      "group_name": "test001",
      "run_env_name": "RELEASE",
      "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "publish_id": "a6e06a00c382436eb524fa2dd343cb6d"
    },
    {
      "name": "aaa",
      "type": 1,
      "version": "0.0.1",
      "req_protocol": "HTTPS",
      "req_method": "GET",
      "req_uri": "/test001",
      "auth_type": "APP",
      "auth_opt": {
        "app_code_auth_type": "DISABLE"
      },
      "tags": ["APIG-SN-test", "test"],
      "cors": false,
      "match_mode": "NORMAL",
      "backend_type": "MOCK",
      "remark": "aaa",
      "group_id": "70f1b578da9b4dfe889b4c33d1b995c2",
      "id": "aebacac6095942b4b2dd2b209bb7b9bc",
      "status": 1,
      "arrange_necessary": 2,
      "register_time": "2018-07-27T11:23:34Z",
      "update_time": "2018-07-27T11:23:34Z",
      "group_name": "test001",
      "run_env_name": "RELEASE",
      "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "publish_id": "1bc8b2b741a04bd4af3ef9d7cd003104"
    }
  ]
}