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.
Atualizado em 2023-05-29 GMT+08:00

Consulta de detalhes de uma versão da API

Função

Esta API é usada para consultar os detalhes de uma versão de API especificada.

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/apis/versions/{version_id}

A tabela a seguir lista o parâmetro no URI.

Tabela 2 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

version_id

Sim

String

ID da versão de API

Solicitação

N/D

Resposta

Tabela 3 Descrição do parâmetro

Parâmetro

Tipo

Descrição

id

String

ID da API

name

String

Nome da API

group_id

String

ID do grupo de APIs ao qual a API pertence

group_name

String

Nome do grupo de APIs ao qual a API pertence

status

Integer

Status da API

type

Integer

Tipo de API

version

String

Versão da API

req_protocol

String

Protocolo de solicitação

req_method

String

Método de solicitação

req_uri

String

Endereço de acesso

auth_type

String

Modo de autenticação de segurança

auth_opt

Object

Parâmetro de modo de autenticação de segurança

authorizer_id

String

ID do autorizador personalizado do front-end

match_mode

String

Modo de correspondência

register_time

Timestamp

Hora em que a API é registrada

update_time

Timestamp

Hora em que a API foi modificada pela última vez

remark

String

Descrição da API

bakend_type

String

Tipo de back-end

run_env_name

String

Nome do ambiente no qual a API foi publicada

run_env_id

String

ID do ambiente no qual a API foi publicada

publish_id

String

ID do registro de publicação

arrange_necessary

Integer

Indica se a orquestração é necessária.

tag

String

Tag de nome de serviço, que deve ser descartada

tags

[]String

Tags da API

cors

Bool

Indica se o CORS é suportado.

body_remark

String

Descrição do corpo da solicitação da API, que pode ser um exemplo de corpo da solicitação, tipo de mídia ou informações de parâmetro

result_normal_sample

String

Exemplo de resposta para uma solicitação bem-sucedida

result_failure_sample

String

Exemplo de resposta para uma solicitação com falha

response_id

String

ID da resposta do gateway

sl_domain

String

Nome do subdomínio do grupo de APIs

sl_domains

Array of strings

Lista de nomes de subdomínio vinculados ao grupo de APIs

version_id

String

Versão da API

publish_time

Timestamp

Hora em que a versão da API é publicada

backend_api

Dicionário

Detalhes do back-end da Web

mock_info

Dicionário

Detalhes do back-end fictício

func_info

Dicionário

Detalhes do back-end do FunctionGraph

req_params

Dicionário

Lista de parâmetros de solicitação

backend_params

Dicionário

Lista de parâmetros de back-end

Tabela 4 Descrição do parâmetro de backend_api

Parâmetro

Tipo

Descrição

id

String

ID de back-end da Web

status

Integer

Status do back-end da Web

url_domain

String

Ponto de extremidade de back-end

version

String

Versão de back-end

req_protocol

String

Protocolo de solicitação

req_method

String

Método de solicitação

req_uri

String

Endereço de acesso

timeout

Integer

Duração do tempo limite em milissegundos

register_time

Timestamp

Hora em que o back-end da Web é registrado

update_time

Timestamp

Hora em que o back-end da Web foi modificado pela última vez

remark

String

Descrição do back-end

vpc_status

String

Indica se um canal da VPC deve ser usado.

vpc_info

String

Informações do canal da VPC

authorizer_id

String

ID do autorizador personalizado de back-end

Tabela 5 Descrição do parâmetro de mock_info

Parâmetro

Tipo

Descrição

id

String

ID de back-end simulado

status

Integer

Status de back-end fictício

version

String

Versão de back-end

result_content

String

Resposta fictícia

register_time

Timestamp

Hora em que o back-end simulado é registrado

update_time

Timestamp

Hora em que o back-end simulado foi modificado pela última vez

remark

String

Descrição do back-end

Tabela 6 Descrição do parâmetro func_info

Parâmetro

Tipo

Descrição

id

String

ID da função

status

Integer

Status da função

version

String

Versão da função

function_urn

String

Função URN

invocation_type

String

Modo de invocação, que pode ser async ou sync

register_time

Timestamp

Hora em que a função é registrada

update_time

Timestamp

Hora em que a função foi atualizada pela última vez

timeout

Integer

Duração do tempo limite em milissegundos

remark

String

Descrição da função

Tabela 7 Descrição do parâmetro de req_params

Parâmetro

Tipo

Descrição

id

String

ID do parâmetro

name

String

Nome do parâmetro

type

String

Tipo de parâmetro

location

String

Localização do parâmetro

default_value

String

Valor padrão

sample_value

String

Exemplo de valor

required

Integer

Indica se o parâmetro é obrigatório.

valid_enable

Integer

Indica se a verificação de validade está habilitada.

remark

String

Descrição do parâmetro

enumerations

String

Valor enumerado

min_num

Integer

Valor mínimo, que é válido quando o tipo de parâmetro é NUMBER

max_num

Integer

Valor máximo, que é válido quando o tipo de parâmetro é NUMBER

min_size

Integer

Comprimento mínimo

max_size

Integer

Comprimento máximo

regular

String

Regra de validação de expressão regular

json_schema

String

Regra de validação JSON

Tabela 8 Descrição do parâmetro de backend_params

Parâmetro

Tipo

Descrição

id

String

ID do parâmetro

req_param_id

String

ID do parâmetro de solicitação para o qual o parâmetro de back-end é mapeado

name

String

Nome do parâmetro

location

String

Localização do parâmetro

origin

Integer

Tipo de parâmetro

value

Integer

Valor do parâmetro

remark

String

Descrição do parâmetro

Tabela 9 Descrição do parâmetro de auth_opt

Parâmetro

Tipo

Descrição

app_code_auth_type

String

Indica se a autenticação de AppCode está habilitada.

Exemplo de resposta:

{
  "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": "HEADER"
  },
  "tags": ["APIG-SN-test", "test"],
  "cors": false,
  "match_mode": "NORMAL",
  "backend_type": "HTTP",
  "group_id": "f71f69876f90456ca6fd18ed012fdc11",
  "result_normal_sample": "hello world!",
  "id": "81efcfd94b8747a0b21e8c04144a4e8c",
  "status": 1,
  "arrange_necessary": 2,
  "register_time": "2018-08-15T03:41:11.0239936Z",
  "update_time": "2018-08-15T03:41:11.0239936Z",
  "group_name": "group0002",
  "sl_domain": "a8be0e466f0e4d8bb18ebd15402cdd66.apigw.example.com",
  "sl_domains": ["a8be0e466f0e4d8bb18ebd15402cdd66.apigw.example.com", "a8be0e466f0e4d8bb18ebd15402cdd66.apigw.example.cn"],
  "version_id": "69b7492e2855487398d45733b9d6147a",
  "publish_time": "2018-08-24T03:10:14Z",
  "backend_api": {
    "url_domain": "xxxxxxxxx",
    "req_protocol": "HTTP",
    "req_method": "GET",
    "req_uri": "/test",
    "timeout": 1000,
    "vpc_status": 2,
    "id": "3442ffd031814e3a8f133a9f1ea08453",
    "status": 1,
    "register_time": "2018-08-15T03:41:11.1019236Z",
    "update_time": "2018-08-15T03:41:11.1019236Z"
  },
  "req_params": [
    {
      "name": "project_id",
      "type": "STRING",
      "location": "PATH",
      "required": 1,
      "valid_enable": 2,
      "id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "type": "STRING",
      "location": "QUERY",
      "required": 2,
      "valid_enable": 2,
      "id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ],
  "backend_params": [
    {
      "name": "project_id",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "project_id",
      "id": "44e03de2351e43a8b18ba9ec1e71d2e9",
      "req_param_id": "593c5560e0924e00af08fb458f850ecb"
    },
    {
      "name": "city",
      "location": "QUERY",
      "origin": "REQUEST",
      "value": "city",
      "id": "b60fbcb5b86f4f5c8705c445b9bd6325",
      "req_param_id": "e0b91bc81ae54f8ea850848d782d6e1e"
    }
  ]
}

Códigos de status

Tabela 10 Códigos de status

Código de status

Descrição

200

OK

400

Solicitação inválida

401

Não autorizado

403

Proibido

404

Não encontrado

500

Erro do servidor interno