Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
Cómo realizar solicitudes a la API
Las solicitudes de consulta Grupos de recursos de AWS son solicitudes HTTP o HTTPS que utilizan un verbo HTTP como GET oPOST.
Puntos finales de Resource Groups
Un punto final es una URL que sirve como punto de entrada para un servicio web. Puede seleccionar un Región de AWS punto final adecuado al realizar sus solicitudes para reducir la latencia. Para obtener información sobre los puntos finales utilizados por Resource Groups, consulte Grupos de recursos de AWSen. Referencia general de Amazon Web Services
Parámetros de consulta
Cada solicitud de consulta debe incluir algunos parámetros comunes para gestionar la autenticación y la selección de una acción. Para obtener más información, consulte Parámetros comunes en la referencia de la Grupos de recursos de AWS API.
Algunas operaciones de la API utilizan listas de parámetros. Estas listas se especifican mediante la siguiente notación:
param.member.n
Los valores de n son números enteros a partir de 1. Todas las listas de parámetros deben seguir esta notación, incluidas las listas que contienen solo un parámetro. Una lista de parámetros de consulta se parece al ejemplo siguiente.
&attribute.member.1=this &attribute.member.2=that
Identificadores de solicitud
En cada respuesta de una API de AWS consultas, hay un ResponseMetadata elemento que contiene un RequestId elemento. Esta cadena es un identificador único que se AWS asigna para proporcionar información de seguimiento. Aunque RequestId se incluye como parte de todas las respuestas, no aparece en las páginas individuales de documentación de la API para mejorar la legibilidad y reducir la redundancia.
Consulta la autenticación de la API
Puede enviar solicitudes de consulta a través de HTTP o HTTPS. Independientemente del protocolo que utilice, debe incluir una firma en cada solicitud de consulta. Para obtener más información sobre cómo crear e incluir una firma, consulte Firmar solicitudes de AWS API en Referencia general de Amazon Web Services.
Bibliotecas disponibles
AWS proporciona bibliotecas, códigos de muestra, tutoriales y otros recursos para los desarrolladores de software que prefieren crear aplicaciones mediante API específicas del idioma en lugar de las herramientas de línea de comandos y la API de consulta. Estas bibliotecas proporcionan funciones básicas (no incluidas en las API), como la autenticación de solicitudes, los reintentos de solicitudes y la gestión de errores, para que sea más fácil empezar. Las bibliotecas y los recursos de Resource Groups están disponibles para los siguientes idiomas y plataformas:
Para obtener más información sobre bibliotecas y códigos de muestra en todos los idiomas, consulta Ejemplos de códigos y bibliotecas.
Realizar solicitudes a la API mediante el método POST
Si no utilizas uno de los AWS SDK, puedes realizar solicitudes de Resource Groups a través de HTTP mediante el método POST request. El POST método requiere que especifiques la operación en el encabezado de la solicitud y proporciones los datos de la operación en formato JSON en el cuerpo de la solicitud.
| Nombre del encabezado | Valor del encabezado |
|---|---|
Host |
El Grupos de recursos de AWS punto final. Por ejemplo: |
X-Amz-Date |
Debe proporcionar la marca de tiempo en el encabezado HTTP Date o en el encabezado AWS x-amz-date. Algunas bibliotecas cliente HTTP no permiten configurar el encabezado Date. Cuando hay un encabezado x-amz-date, el sistema ignora cualquier encabezado de fecha durante la autenticación de la solicitud. El encabezado x-amz-date debe especificarse en el formato básico ISO 8601. Por ejemplo: |
Authorization |
El conjunto de parámetros de autorización que se AWS utiliza para garantizar la validez y autenticidad de la solicitud. Para obtener más información sobre cómo crear este encabezado, consulte el proceso de firma de la versión 4 en Referencia general de Amazon Web Services. |
X-Amz-Target |
Especifica el espacio de nombres y la versión de Resource Groups, así como la operación que desea realizar.
notaPara los Resource Groups, utilice siempre la versión Por ejemplo, para llamar a la
|
Content-Type |
Especifica el formato de entrada. Utilice el siguiente valor.
|
Accept |
Especifica el formato de respuesta. Utilice el siguiente valor.
|
Content-Length |
Tamaño de la carga útil en bytes. |
Content-Encoding |
Especifica el formato de codificación de la entrada y la salida. Utilice el siguiente valor.
|
A continuación, se muestra un ejemplo de encabezado para una solicitud HTTP destinada a crear un grupo de recursos que incluya todos los recursos que están etiquetadosStage=Test. En este ejemplo, la Authorization línea está redactada aquí para facilitar la lectura. No lo pongas en palabras en tu solicitud 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"} }
