Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ API Gateway/ Referência de API/ APIs compartilhadas de gateway (para usuários existentes)/ Vinculação de chaves de assinatura/ Consulta da lista de chaves de assinatura vinculadas a uma API

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Consulta da lista de chaves de assinatura vinculadas a uma API

Função

Esta API é usada para consultar a lista de chaves de assinatura que foram vinculadas a uma API especificada. Apenas uma chave de assinatura pode ser vinculada a uma API em um ambiente.

URI

A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.

**Tabela 1** Método de solicitação HTTP/HTTPS e URI
Método de solicitação	URI
GET	/v1.0/apigw/sign-bindings/binded-signs[?page_no, page_size, api_id, sign_id, sign_name,env_id]

Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
As condições de consulta incluem: api_id, sign_id, sign_name, env_id, page_size e page_no.

A tabela a seguir lista os parâmetros no URI.

**Tabela 2** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
api_id	Sim	String	ID da API
sign_id	Não	String	ID da chave de assinatura
sign_name	Não	String	Nome da chave de assinatura
env_id	Não	String	ID do ambiente

Solicitação

N/D

Resposta

**Tabela 3** Descrição do parâmetro
Parâmetro	Tipo	Descrição
total	Integer	Número total de chaves de assinatura que correspondem às condições de consulta
size	Integer	Comprimento da lista de chaves de assinatura devolvida
bindings	Dicionário	Lista de chaves de assinatura

**Tabela 4** Descrição do parâmetro de bindings
Parâmetro	Tipo	Descrição
id	String	ID de vinculação
api_id	String	ID da API
api_name	String	Nome da API
api_remark	String	Descrição da API
group_name	String	Nome do grupo de APIs ao qual a API pertence
api_type	Integer	Tipo de API
sign_id	String	ID da chave de assinatura
sign_name	String	Nome da chave de assinatura
sign_key	String	Chave de assinatura
sign_secret	String	Segredo de assinatura
env_id	String	ID do ambiente no qual a API foi publicada
env_name	String	Nome do ambiente no qual a API foi publicada
binding_time	Timestamp	Hora em que a chave de assinatura é vinculada à API
publish_id	String	ID de publicação da API

Exemplo de resposta:

{
  "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"
    }
  ]
}