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 de gateway dedicadas (V2)/ Gerenciamento de chaves de assinatura/ Consulta de chaves de assinatura
Atualizado em 2023-05-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de chaves de assinatura

Função

Esta API é usada para consultar todas as chaves de assinatura.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/signs

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento.

instance_id

Sim

String

ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

offset

Não

Long

Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0.

Padrão: 0

limit

Não

Integer

Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500.

Mínimo: 1

Máximo: 500

Padrão: 20

id

Não

String

ID da chave de assinatura.

name

Não

String

Nome da chave de assinatura.

precise_search

Não

String

Nome do parâmetro (name) para correspondência exata.

Parâmetros de solicitação

Tabela 3 Parâmetros do cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

size

Integer

Comprimento da lista de recursos retornados.

total

Long

Número de recursos que atendem às condições de consulta.

signs

Array of SignatureWithBindNum objects

Lista de chaves de assinatura.
Tabela 5 SignatureWithBindNum

Parâmetro

Tipo

Descrição

name

String

Nome da chave de assinatura. Ele pode conter letras, dígitos e sublinhados (_) e deve começar com uma letra.

Mínimo: 3

Máximo: 64

sign_type

String

Tipo de chave de assinatura.

  • hmac

  • básico

  • public_key

  • aes

Para usar uma chave básica de assinatura, certifique-se de que sua versão de gateway a suporte. Se o gateway não suportar este tipo de chave de assinatura, contacte o suporte técnico para actualizar o gateway.

Para usar uma chave de assinatura public_key, certifique-se de que o recurso public_key tenha sido configurado para o gateway. Para obter detalhes, consulte "Apêndice" > "Recursos suportados". Se o seu gateway não for compatível com esse recurso, entre em contato com o suporte técnico para habilitá-lo.

Para usar uma chave de assinatura AES, certifique-se de que sua versão de gateway a suporte. Se o gateway não suportar este tipo de chave de assinatura, contacte o suporte técnico para actualizar o gateway.

Valores de enumeração:

  • hmac

  • basic

  • public_key

  • aes

sign_key

String

Chave de assinatura.

  • hmac: o valor contém de 8 a 32 caracteres, incluindo letras, dígitos, sublinhados (_) e hifens (-). Deve começar com uma letra ou dígito. Se não for especificado, um valor é gerado automaticamente.

  • básico: o valor contém de 4 a 32 caracteres, incluindo letras, dígitos, sublinhados (_) e hifens (-). Deve começar com uma letra. Se não for especificado, um valor é gerado automaticamente.

  • public_key: o valor contém de 8 a 512 caracteres, incluindo letras, dígitos e caracteres especiais (_-+/=). Deve começar com uma letra, dígito, sinal de adição (+), ou barra (/). Se não for especificado, um valor é gerado automaticamente.

  • aes: o valor contém 16 caracteres se o algoritmo aes-128-cfb for usado ou 32 caracteres se o algoritmo aes-256-cfb for usado. Letras, dígitos e caracteres especiais (_-!@#$%+/=) são permitidos. O valor deve começar com uma letra, dígito, sinal de adição (+), ou barra (/). Se não for especificado, um valor é gerado automaticamente.

sign_secret

String

Segredo de assinatura.

  • hmac: o valor contém de 16 a 64 caracteres. Letras, dígitos e caracteres especiais (_-!@#$%) são permitidos. Deve começar com uma letra ou dígito. Se não for especificado, um valor é gerado automaticamente.

  • básico: o valor contém de 8 a 64 caracteres. Letras, dígitos e caracteres especiais (_-!@#$%) são permitidos. Deve começar com uma letra ou dígito. Se não for especificado, um valor é gerado automaticamente.

  • public_key: o valor contém de 15 a 2048 caracteres, incluindo letras, dígitos e caracteres especiais (_-!@#$%+/=). Deve começar com uma letra, dígito, sinal de adição (+), ou barra (/). Se não for especificado, um valor é gerado automaticamente.

  • aes: o valor contém 16 caracteres, incluindo letras, dígitos e caracteres especiais (_-!@#$%+/=). Deve começar com uma letra, dígito, sinal de adição (+), ou barra (/). Se não for especificado, um valor é gerado automaticamente.

sign_algorithm

String

Algoritmo de assinatura. Especifique um algoritmo de assinatura somente ao usar uma chave de assinatura AES. Por padrão, nenhum algoritmo é usado.

Valores de enumeração:

  • aes-128-cfb

  • aes-256-cfb

update_time

String

Hora da atualização.

create_time

String

Tempo de criação.

id

String

ID da chave de assinatura.

bind_num

Integer

Número de APIs vinculadas.

ldapi_bind_num

Integer

Número de back-ends personalizados vinculados.

Atualmente, este parâmetro não é suportado.

Código de status: 400

Tabela 6 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 401

Tabela 7 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 403

Tabela 8 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 9 Parâmetros de corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitações

Nenhum

Exemplo de respostas

Código de status: 200

OK

{
  "total" : 2,
  "size" : 2,
  "signs" : [ {
    "sign_secret" : "signsecretsignsecretsignsecretsignsecret",
    "update_time" : "2018-02-07T02:00:27.964766Z",
    "create_time" : "2018-02-06T12:17:36Z",
    "name" : "signature_demo",
    "id" : "0b0e8f456b8742218af75f945307173c",
    "sign_key" : "signkeysignkey",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  }, {
    "sign_secret" : "9ce16b029034464898ee33540c42e16a",
    "update_time" : "2020-07-30T03:56:58Z",
    "create_time" : "2020-07-30T03:56:58Z",
    "name" : "Signature_udlu",
    "id" : "9dc388382fba485aadd19f932303f4c9",
    "sign_key" : "ca50c5b670044c83b5b890a9a68a30d5",
    "sign_type" : "hmac",
    "bind_num" : 0,
    "ldapi_bind_num" : 0
  } ]
}

Código de status: 400

Solicitação inválida

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de status: 401

Não autorizado

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de status: 403

Proibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de status: 500

Erro do servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

500

Erro do servidor interno

Códigos de erro

Consulte Códigos de erro.