As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Usando a API para o Amazon EC2
Importante
A partir de 14 de outubro de 2022, as respostas HTTP das APIs do Amazon EC2 não incluem mais um elemento de frase de motivo. Conforme recomendado pela RFC7230
Fornecemos a API de consulta para o Amazon EC2, bem como kits de desenvolvimento de software (SDK) para AWS que você possa acessar o Amazon EC2 a partir da sua linguagem de programação preferida. Para obter mais informações, consulte o Guia do desenvolvedor do Amazon EC2.
Conteúdo
Conhecimento necessário
Se você planeja acessar o Amazon EC2 por meio de uma API, deve estar familiarizado com o seguinte:
-
XML
-
Serviços da web
-
Solicitações HTTP
-
Uma ou mais linguagens de programação, como Java, PHP, Perl, Python, Ruby, C# ou C++.
APIs disponíveis para o Amazon EC2
A API de consulta do Amazon EC2 fornece solicitações HTTP ou HTTPS que usam o verbo HTTP GET ou POST e um parâmetro de consulta chamado. Action
AWS fornece bibliotecas, exemplos de código, tutoriais e outros recursos para desenvolvedores de software que preferem criar aplicativos usando APIs específicas de um idioma em vez de enviar uma solicitação por HTTP ou HTTPS. Essas bibliotecas fornecem funções básicas que cuidam automaticamente de tarefas como assinar criptograficamente suas solicitações, tentar novamente solicitações e lidar com respostas de erro, para que seja mais fácil começar.
Para obter mais informações, consulte Criar recursos do Amazon EC2 usando um AWS SDK no Guia do desenvolvedor do Amazon EC2.
Parâmetros de consulta comuns
A maioria das ações da API do Amazon EC2 suporta os parâmetros descritos nas tabelas a seguir. Os parâmetros comuns variam dependendo se você está usando o Signature versão 2 ou o Signature versão 4 para assinar suas solicitações. Para obter mais informações, consulte Assinatura de solicitações de AWS API no Guia do usuário do IAM.
Parâmetros para assinatura versão 4
| Name (Nome) | Description | Obrigatório |
|---|---|---|
|
|
A ação a ser executada. Exemplo: |
Sim |
|
|
A versão da API do a ser usada. |
Sim |
|
|
O algoritmo de hash que você usa para criar a assinatura da solicitação. Exemplo: |
Sim |
|
|
O escopo da credencial para a solicitação, no formato Exemplo: |
Sim |
|
|
A data e a hora em que a solicitação é assinada, no formato YYYYMMDDTHHMMSSZ. A data deve corresponder à data incluída no escopo da credencial do Exemplo: |
Sim |
X-Amz-SignedHeaders |
Os cabeçalhos que você está incluindo como parte da solicitação. No mínimo, você deve incluir o Exemplo: |
Sim |
|
|
Uma assinatura derivada da sua chave de acesso secreta. Exemplo: |
Sim |
|
|
O token de segurança temporário obtido por meio de uma chamada para AWS Security Token Service. Exemplo: |
Não |
|
|
Verifica se você tem as permissões necessárias para a ação, sem realmente fazer a solicitação. Se você tiver as permissões necessárias, a solicitação retornará |
Não |
Os X-Amz-Signature parâmetros X-Amz-AlgorithmX-Amz-Credential,X-Amz-SignedHeaders, e podem ser especificados como parâmetros separados na string de consulta ou seus valores podem ser incluídos em um único Authorization cabeçalho. Para obter mais informações, consulte Assinatura de solicitações de AWS API no Guia do usuário do IAM.
Parâmetros para assinatura versão 2
| Name (Nome) | Description | Obrigatório |
|---|---|---|
|
|
A ação a ser executada. Exemplo: |
Sim |
|
|
A versão da API do a ser usada. |
Sim |
|
|
O ID da chave de acesso do remetente da solicitação. Isso identifica a conta que será cobrada pelo uso do serviço. A conta associada ao ID da chave de acesso deve estar cadastrada no Amazon EC2 ou a solicitação não será aceita. Exemplo: |
Sim |
|
|
A data e a hora em que a assinatura incluída na solicitação expira, no formato YYYY-MM-DDThh:mm:ssZ. Para obter mais informações, consulte ISO 8601 Exemplo: |
Condicional. As solicitações devem incluir um Timestamp ouExpires, mas não podem conter ambos. |
|
|
A data e a hora em que a solicitação é assinada, no formato YYYY-MM-DDThh:mm:ssZ. Para obter mais informações, consulte ISO 8601 Exemplo: |
Condicional. As solicitações devem incluir um Timestamp ouExpires, mas não podem conter ambos. |
|
|
A assinatura da solicitação. Exemplo: |
Sim |
|
|
O algoritmo de hash que você usa para criar a assinatura da solicitação. Valores válidos: Exemplo: |
Sim |
|
|
A versão de assinatura que você usa para assinar a solicitação. Defina este valor como Exemplo: |
Sim |
|
|
Verifica se você tem as permissões necessárias para a ação, sem realmente fazer a solicitação. Se você tiver as permissões necessárias, a solicitação retornará |
Não |
|
|
O token de segurança temporário obtido por meio de uma chamada para AWS Security Token Service. Exemplo: |
Não |
Os valores dos parâmetros devem ser URL-encoded. Isso vale para qualquer parâmetro de consulta passado para o Amazon EC2 e normalmente é necessário no Signature parâmetro. Alguns clientes fazem isso automaticamente, mas essa não é a norma.
