Effettuare richieste API

Le richieste di query per AWS Resource Groups sono richieste HTTP o HTTPS che utilizzano un verbo HTTP come GET oPOST.

Endpoint Resource Groups

Un endpoint è un URL che funge da punto di ingresso per un servizio Web. È possibile selezionare un Regione AWS endpoint appropriato quando si effettuano richieste per ridurre la latenza. Per informazioni sugli endpoint utilizzati da Resource Groups, vedere AWS Resource Groupsin. Riferimenti generali di Amazon Web Services

Parametri di query

Ogni richiesta di interrogazione deve includere alcuni parametri comuni per gestire l'autenticazione e la selezione di un'azione. Per ulteriori informazioni, consulta Parametri comuni nell'AWS Resource Groups API Reference.

Alcune operazioni API richiedono elenchi di parametri. Questi elenchi vengono specificati utilizzando la seguente notazione:

param.member.n

I valori di n sono numeri interi a partire da 1. Tutti gli elenchi di parametri devono seguire questa notazione, inclusi gli elenchi che contengono un solo parametro. Un elenco di parametri di interrogazione è simile all'esempio seguente.

&attribute.member.1=this
&attribute.member.2=that

Identificatori della richiesta

In ogni risposta di un'API di AWS query, c'è un ResponseMetadata elemento che contiene un RequestId elemento. Questa stringa è un identificatore univoco che viene AWS assegnato per fornire informazioni di tracciamento. Sebbene RequestId sia inclusa in ogni risposta, non è elencata nelle pagine della documentazione delle singole API per migliorare la leggibilità e ridurre la ridondanza.

Autenticazione tramite API Query

È possibile inviare richieste di query tramite HTTP o HTTPS. Indipendentemente dal protocollo utilizzato, è necessario includere una firma in ogni richiesta di query. Per ulteriori informazioni sulla creazione e l'inclusione di una firma, consulta Signing AWS API Requests in Riferimenti generali di Amazon Web Services.

Librerie disponibili

AWS fornisce librerie, codice di esempio, tutorial e altre risorse per gli sviluppatori di software che preferiscono creare applicazioni utilizzando API specifiche del linguaggio anziché gli strumenti da riga di comando e l'API Query. Queste librerie forniscono funzioni di base (non incluse nelle API), come l'autenticazione delle richieste, i nuovi tentativi di richiesta e la gestione degli errori, in modo che sia più facile iniziare. Le librerie e le risorse di Resource Groups sono disponibili per le seguenti lingue e piattaforme:

• AWS SDK per Go

• AWS SDK for Java 2.x

• AWS SDK per Java 1.x

• AWS SDK per JavaScript

• AWS SDK per in JavaScript Node.js

• AWS SDK per .NET

• AWS SDK per PHP

• AWS SDK per Python (Boto)

• AWS SDK per Ruby

• AWS SDK per Rust

Per ulteriori informazioni sulle librerie e sul codice di esempio in tutte le lingue, vedi Codice di esempio e librerie.

Effettuare richieste API utilizzando il metodo POST

Se non utilizzi uno degli AWS SDK, puoi effettuare richieste Resource Groups su HTTP utilizzando il metodo di POST richiesta. Il POST metodo richiede di specificare l'operazione nell'intestazione della richiesta e di fornire i dati per l'operazione in formato JSON nel corpo della richiesta.

Nome intestazione	Valore intestazione
Host	L' AWS Resource Groups endpoint. Ad esempio: tagging.us-east-1.amazonaws.com
X-Amz-Date	È necessario fornire il timestamp nell'intestazione HTTP Date o nell'intestazione x-amz-date. AWS Alcune librerie client HTTP non consentono di impostare l'intestazione Date. Quando è presente un'intestazione x-amz-date, il sistema ignora qualsiasi intestazione Date durante l'autenticazione della richiesta. L'intestazione x-amz-date deve essere specificata nel formato base ISO 8601. Ad esempio: 20130315T092054Z
Authorization	L'insieme di parametri di autorizzazione AWS utilizzato per garantire la validità e l'autenticità della richiesta. Per ulteriori informazioni sulla creazione di questa intestazione, vedere Processo di firma della versione 4 di Signature in. Riferimenti generali di Amazon Web Services
X-Amz-Target	Specificate lo spazio dei nomi e la versione di Resource Groups e l'operazione che si desidera eseguire. ResourceGroupsTaggingAPI_20170126.API_Name Nota Per i Resource Groups, usa sempre la versione 20170126. Ad esempio, per chiamare l'GetTagValuesoperazione, utilizzate il seguente valore di destinazione. ResourceGroupsTaggingAPI_20170126.GetTagValues
Content-Type	Specificate il formato di input. Utilizzate il seguente valore. application/json
Accept	Specificate il formato della risposta. Utilizzate il seguente valore. application/json
Content-Length	Dimensione del payload in byte.
Content-Encoding	Speciifica il formato di codifica dell'input e dell'output. Utilizzate il seguente valore. amz-1.0

Di seguito è riportato un esempio di intestazione per una richiesta HTTP per creare un gruppo di risorse che include tutte le risorse Stage=Test etichettate. In questo esempio, la Authorization riga è racchiusa in parole per facilitarne la lettura. Non inserirla in una parola nella richiesta effettiva.

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"}
}