A autoassinatura de requisições de API da Alibaba Cloud exige metadados como estilo da API, protocolos compatíveis e definições de parâmetros. Saiba como ler e obter esses metadados.
Visão geral dos metadados de produtos em nuvem
Os metadados do OpenAPI formam o conjunto de informações descritivas das APIs de um produto em nuvem. Durante a assinatura, extraia desses metadados o estilo da API, os protocolos compatíveis, os métodos de requisição, além dos nomes, tipos e locais dos parâmetros.
Visão geral do produto e da versão (Info)
Inclui o estilo da API, o código do produto e a versão.
Exemplo:
{"style":"RPC","product":"Ecs","version":"2014-05-26"}
Coleção de resumos de API (apis)
Um Map indexado pelo nome da API, em que cada valor corresponde a um resumo da API com os seguintes parâmetros:
|
Nome do parâmetro |
Descrição |
Exemplo |
|
methods |
Métodos de requisição compatíveis. |
Tanto POST quanto GET retornam resultados idênticos. |
|
schemes |
Protocolos compatíveis. |
HTTP e HTTPS são compatíveis. |
|
parameters |
Parâmetros de requisição. |
Descreve o nome, o local (query, path ou body), o tipo e a obrigatoriedade de cada parâmetro. |
Coleção de endpoints (endpoints)
Endpoints de serviço do produto em nuvem.
Como obter metadados
Método 1: Obter metadados do produto em nuvem
Na página de ou documentação da API, selecione um produto em nuvem, como Elastic Compute Service (ECS), e clique em Get Metadata abaixo do nome do produto.
Método 2: Obter metadados de uma API específica
Acesse a página de ou documentação da API, selecione um produto em nuvem como ECS, escolha a API desejada e clique em Get Metadata no canto superior direito.
Método 3: Chamar a API de metadados
A API de metadados é acessível publicamente sem autenticação. Utilize os endpoints a seguir para recuperar os metadados. A referência completa da API está disponível no ou no guia de uso de metadados.
|
Descrição da API |
URL da API |
Método de requisição |
|
Listar todos os códigos e versões de produtos em nuvem |
https://api.aliyun.com/meta/v1/products.json?language=EN_US |
GET |
|
Obter metadados de um produto e versão específicos |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/api-docs.json |
GET |
|
Recuperar metadados de uma API específica |
https://api.aliyun.com/meta/v1/products/{product}/versions/{version}/apis/{api_name}/api.json |
GET |