Criação de uma solicitação de API
Esta seção descreve a estrutura de uma API REST e usa a API do IAM para obtenção de um token de usuário como um exemplo para descrever como chamar uma API. O token obtido é usado para autenticar a chamada de outras APIs.
URI de solicitação
Um URI de solicitação está no seguinte formato:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
Parâmetro |
Descrição |
---|---|
URI-scheme |
Protocolo usado para transmitir solicitações. Todas as API usam HTTPS. |
Endpoint |
Nome de domínio ou endereço IP do servidor que possui o serviço REST. A CDN é um serviço de nível global e a seleção de região não é necessária. Obtenha o ponto final do Identity and Access Management (IAM) na região ALL de Regiões e endpoints. O ponto final do IAM na região ALL é iam.myhuaweicloud.com. |
resource-path |
Caminho de acesso de uma API para executar uma operação especificada. Obtenha o caminho a partir do URI de uma API. Por exemplo, o resource-path da API usada para obter um token de usuário é /v3/auth/tokens. |
query-string |
Parâmetro de consulta, que é opcional. Certifique-se um ponto de interrogação (?) está incluído antes de cada parâmetro de consulta no formato "Parameter name=Parameter value". Por exemplo, ? limit=10 indica que um máximo de 10 registros de dados serão exibidos. |
Por exemplo, para obter um token do IAM na região ALL, obtenha o endpoint do IAM (iam.myhuaweicloud.com) para essa região e o resource-path (/v3/auth/tokens) no URI da API usado para obter um token de usuário. Em seguida, construa o URI da seguinte forma:
https://iam.myhuaweicloud.com/v3/auth/tokens
Para simplificar a exibição de URI neste documento, cada API é fornecida apenas com um resource-path e um método de solicitação. O URI-scheme de todas as API é HTTPS, e os endpoints de todas as API na mesma região são idênticos.
Métodos de solicitação
Método |
Descrição |
---|---|
GET |
Solicita que o servidor retorne os recursos especificados. |
PUT |
Solicita que o servidor atualize os recursos especificados. |
POST |
Solicita que o servidor adicione recursos ou execute operações especiais. |
DELETE |
Solicita que o servidor exclua recursos especificados, por exemplo, um objeto. |
HEAD |
O mesmo que GET, exceto que o servidor deve retornar apenas o cabeçalho da resposta. |
PATCH |
Solicita ao servidor que atualize o conteúdo parcial de um recurso especificado. Se o recurso não existir, um novo recurso será criado. |
Por exemplo, no caso da API usada para obter um token de usuário, o método de solicitação é POST. A solicitação é o seguinte:
POST https://iam.myhuaweicloud.com/v3/auth/tokens
Cabeçalho da solicitação
Você também pode adicionar campos de cabeçalho adicionais a uma solicitação, como os campos exigidos por um método URI ou HTTP especificado. Por exemplo, para solicitar as informações de autenticação, adicione Content-type, que especifica o tipo de corpo da solicitação.
Parâmetro |
Descrição |
Obrigatório |
Exemplo |
---|---|---|---|
Host |
Especifica o nome de domínio do servidor e o número da porta dos recursos que estão sendo solicitados. O valor pode ser obtido a partir do URL da API de serviço. O valor está no formato de Hostname:número da porta. Se o número da porta não for especificado, a porta padrão será usada. O número de porta padrão para HTTPS é 443. |
Não Este campo é obrigatório para autenticação baseada em AK/SK. |
code.test.com ou code.test.com:443 |
Content-Type |
Especifica o tipo MIME do corpo da solicitação. É aconselhável usar o valor padrão application/json. Para as API usadas para carregar objetos ou imagens, o valor pode variar dependendo do tipo de fluxo. |
Sim |
application/json |
Content-Length |
Especifica o comprimento do corpo da solicitação. A unidade é byte. |
Não |
3495 |
X-Project-Id |
Especifica a ID do projeto. Obtenha o ID do projeto seguindo as instruções em Obtenção de um ID de projeto. Esse parâmetro é obrigatório para uma solicitação de um usuário Dedicated Cloud (DeC) ou de vários projetos. |
Não Este campo é obrigatório para solicitações que usam autenticação baseada em AK/SK no cenário DeC ou cenário multiprojeto. |
e9993fc787d94b6c886cbaa340f9c0f4 |
X-Auth-Token |
Especifica um token de usuário. É uma resposta à API usada para obter um token de usuário. Esta API é a única que não requer autenticação. Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho é o valor do token. |
Não Este campo é obrigatório para autenticação baseada em token. |
O seguinte é parte de um exemplo de token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ |
In addition to supporting token-based authentication, public cloud API also support authentication using access key ID/secret access key (AK/SK). Durante a autenticação baseada em AK/SK, um SDK é usado para assinar a solicitação, e os campos de cabeçalho Authorization (informações de assinatura) e X-Sdk-Date (hora em que a solicitação é enviada) são adicionados automaticamente à solicitação.
Para obter mais informações, consulte AK/SK-based Authentication em Autenticação.
A API usada para obter um token de usuário não requer autenticação. Portanto, apenas o campo Content-typeprecisa ser adicionado às solicitações para chamar a API. Um exemplo de tais solicitações é o seguinte:
POST https://iam.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
Corpo da solicitação
Esta parte é opcional. O corpo de uma solicitação geralmente é enviado em um formato estruturado, conforme especificado no campo de cabeçalho Content-Type. O corpo da solicitação transfere o conteúdo, exceto o cabeçalho da solicitação. Se o corpo da solicitação contiver caracteres chineses, converta os caracteres chineses para o formato de codificação UTF-8.
O corpo da solicitação varia entre as API. Algumas API não exigem o corpo da solicitação, como as API solicitadas usando os métodos GET e DELETE.
No caso da API usada para obter um token de usuário, os parâmetros da solicitação e a descrição do parâmetro podem ser obtidos da solicitação da API. O seguinte fornece um exemplo de solicitação com um corpo incluído. Substitua username, domainname (nome da conta) e senha ******** (login) pelos valores reais. CDN é um serviço de nível de projeto. Digite cn-north-1 em Name.
O parâmetro scope especifica onde um token entra em vigor. Você pode definir scope para uma conta ou um projeto em uma conta. No exemplo a seguir, o token tem efeito somente para os recursos em um projeto especificado. Para obter mais informações sobre essa API, consulte Obtenção de um token de usuário.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
POST https://iam.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username",
"password": "********",
"domain": {
"name": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "cn-north-1"
}
}
}
}
|
Se todos os dados necessários para a solicitação da API estiverem disponíveis, você poderá enviar a solicitação para chamar a API por meio de curl, Postman ou coding. Na resposta à API usada para obter um token de usuário, x-subject-token é o token de usuário desejado. Esse token pode ser usado para autenticar a chamada de outras APIs.