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.
Actualización más reciente 2023-03-29 GMT+08:00

Consulta de la lista de API vinculadas a una clave de firma

Función

Esta API se utiliza para consultar la lista de API que se han enlazado a una clave de firma especificada.

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/sign-bindings/binded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_id]

  • 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: sign_id, env_id, api_id, api_name, group_id, page_size y page_no.

En la siguiente tabla se enumeran los parámetros del URI.

Tabla 2 Descripción de parámetro

Parámetro

Obligatorio

Tipo

Descripción

sign_id

String

ID de clave de firma

env_id

No

String

ID de entorno

api_id

No

String

ID de API

api_name

No

String

Nombre de la API

group_id

No

String

ID de grupo de API

Solicitud

N/A

Respuesta

Tabla 3 Descripción de parámetro

Parámetro

Tipo

Descripción

total

Integer

Número total de API que coinciden con las condiciones de consulta

size

Integer

Longitud de la lista de API devuelta

bindings

Dictionary

Lista de API

Tabla 4 Descripción de parámetros de las vinculaciones

Parámetro

Tipo

Descripción

id

String

ID de vinculación

api_id

String

ID de API

api_name

String

Nombre de la API

api_remark

String

Descripción de la API

group_name

String

Nombre del grupo de API al que pertenece la API

api_type

Integer

Tipo de API

sign_id

String

ID de clave de firma

sign_name

String

Nombre de clave de firma

sign_key

String

Clave de firma

sign_secret

String

Secreto de firma

env_id

String

ID del entorno en el que se ha publicado la API

env_name

String

Nombre del entorno en el que se ha publicado la API

binding_time

Timestamp

Hora en la que la clave de firma está enlazada a la API

publish_id

String

ID de publicación de API

Ejemplo de respuesta:

{
  "total": 2,
  "size": 2,
  "bindings": [
    {
      "id": "4588ec6f5dab4f67b298dc693f58029e",
      "api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2",
      "api_name": "aaa",
      "api_remark": "",
      "group_name": "asd",
      "api_type": 1,
      "sign_id": "3a793b65a9034bdfae08924f149bfb4a",
      "sign_name": "signature01",
      "sign_key": "abcd_1234",
      "sign_secret": "******",
      "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "env_name": "RELEASE",
      "binding_time": "2018-02-07T07:08:51Z",
      "publish_id": "3a793b65a9034bdfae08924f149bfsda"
    },
    {
      "id": "d8426fb090e442c4a56a35e451bea085",
      "api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b",
      "api_name": "bbb",
      "api_remark": "",
      "group_name": "asd",
      "api_type": 1,
      "sign_id": "3a793b65a9034bdfae08924f149bfb4a",
      "sign_name": "signature01",
      "sign_key": "abcd_1234",
      "sign_secret": "******",
      "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
      "env_name": "RELEASE",
      "binding_time": "2018-02-07T03:17:26Z",
      "publish_id": "3a793b65a9034bdfae08924f149bfsda"
    }
  ]
}

Códigos de estado

Tabla 5 Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error