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á.
Como fazer solicitações de API
As solicitações de consulta para AWS Resource Groups o. são solicitações HTTP ou HTTPS que usam um verbo HTTP, como GET ouPOST.
Endpoints do Resource Groups
Um endpoint é uma URL que serve como ponto de entrada para um serviço web. Você pode selecionar um Região da AWS endpoint apropriado ao fazer suas solicitações para reduzir a latência. Para obter informações sobre os endpoints usados pelo Resource Groups, consulte AWS Resource Groupsno Referência geral da Amazon Web Services.
Parâmetros de consulta
Cada solicitação de consulta deve incluir alguns parâmetros comuns para lidar com a autenticação e a seleção de uma ação. Para obter mais informações, consulte Parâmetros comuns na Referência AWS Resource Groups da API.
Algumas operações de API usam listas de parâmetros. Essas listas são especificadas usando a seguinte notação:
param.member.n
Os valores de n são números inteiros a partir de 1. Todas as listas de parâmetros devem seguir essa notação, incluindo listas que contêm somente um parâmetro. Uma lista de parâmetros de consulta se parece com o exemplo a seguir.
&attribute.member.1=this &attribute.member.2=that
Identificadores de solicitação
Em cada resposta de uma API de AWS consulta, há um ResponseMetadata elemento que contém um RequestId elemento. Essa string é um identificador exclusivo que é AWS atribuído para fornecer informações de rastreamento. Embora RequestId esteja incluído como parte de cada resposta, ele não está listado nas páginas individuais de documentação da API para melhorar a legibilidade e reduzir a redundância.
autenticação da API de consulta
Você pode enviar solicitações de consulta por HTTP ou HTTPS. Independentemente do protocolo usado, você deve incluir uma assinatura em cada solicitação de consulta. Para obter mais informações sobre como criar e incluir uma assinatura, consulte Assinatura de solicitações de AWS API no Referência geral da Amazon Web Services.
Bibliotecas disponíveis
AWS fornece bibliotecas, exemplos de código, tutoriais e outros recursos para desenvolvedores de software que preferem criar aplicativos usando APIs específicas da linguagem em vez das ferramentas de linha de comando e da API de consulta. Essas bibliotecas fornecem funções básicas (não incluídas nas APIs), como autenticação de solicitações, novas tentativas de solicitação e tratamento de erros, para facilitar o início. As bibliotecas e os recursos do Resource Groups estão disponíveis para as seguintes linguagens e plataformas:
Para obter mais informações sobre bibliotecas e exemplos de código em todas as linguagens, consulte Código de amostra e bibliotecas.
Fazer solicitações de API usando o método POST
Se você não usa um dos AWS SDKs, pode fazer solicitações de Resource Groups por HTTP usando o método POST request. O POST método exige que você especifique a operação no cabeçalho da solicitação e forneça os dados da operação no formato JSON no corpo da solicitação.
| Nome do cabeçalho | Valor de cabeçalho |
|---|---|
Host |
O AWS Resource Groups ponto final. Por exemplo: |
X-Amz-Date |
Você deve fornecer o timestamp no cabeçalho HTTP Date ou no cabeçalho AWS x-amz-date. Algumas bibliotecas de cliente HTTP não permitem que você defina o cabeçalho de data. Quando um cabeçalho x-amz-date está presente, o sistema ignora qualquer cabeçalho de data durante a autenticação da solicitação. O cabeçalho x-amz-date deve ser especificado no formato básico ISO 8601. Por exemplo: |
Authorization |
O conjunto de parâmetros de autorização AWS usado para garantir a validade e a autenticidade da solicitação. Para obter mais informações sobre a construção desse cabeçalho, consulte Processo de assinatura do Signature versão 4 no Referência geral da Amazon Web Services. |
X-Amz-Target |
Especifica o namespace e a versão do Resource Groups e a operação que você deseja realizar.
notaPara os Resource Groups, sempre use a versão Por exemplo, para chamar a
|
Content-Type |
Especifica o formato de entrada. Use o seguinte valor.
|
Accept |
Especifica o formato da resposta. Use o seguinte valor.
|
Content-Length |
Tamanho da carga em bytes. |
Content-Encoding |
Especifica o formato de codificação da entrada e da saída. Use o seguinte valor.
|
Veja a seguir um exemplo de cabeçalho para uma solicitação HTTP para criar um grupo de recursos que inclui todos os recursos marcadosStage=Test. Neste exemplo, a Authorization linha é dividida aqui para facilitar a leitura. Não inclua isso em sua solicitação real.
POST / HTTP/1.1 Host: resource-groups.us-east-1.amazonaws.com X-Amz-Date: 20180112T092034Z Accept-Encoding: identity Authorization: AWS4-HMAC-SHA256 Credential=REDACTED/20220113/us-west-2/resource-groups/aws4_request, SignedHeaders=content-encoding;content-length;content-type;host;x-amz-date;x-amz-target, Signature=EXAMPLE5cb91f88f1EXAMPLEa02d3af93dEXAMPLE91e5d03588EXAMPLE88ff1d Content-Type: application/json Accept: application/json Content-Length: 283 { "Description": "Resources created for the testing stage.", "Name": "QueryGroup", "ResourceQuery": { "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}", "Type": "TAG_FILTERS_1_0" }, "Tags": {"Department": "Finance"} }
