通过提出 HTTP 查询请求来调用 API
本部分包含有关使用适用于 Amazon Organizations 的查询 API 的常规信息。有关 API 操作和错误的详细信息,请参阅 Amazon Organizations API 参考。
注意
您可以使用 Amazon 开发工具包之一,代替对 Amazon Organizations 查询 API 进行直接调用。Amazon 开发工具包中包含适用于各种编程语言和平台(Java、Ruby、.NET、iOS、Android 等)的库和示例代码。开发工具包提供便捷的方式来创建对 Amazon Organizations 和 Amazon 的编程访问。例如,软件开发工具包执行以下类似任务:加密签署请求、管理错误以及自动重试请求。有关 Amazon 开发工具包的信息(包括如何下载及安装),请参阅适用于 Amazon Web Services 的工具
使用适用于 Amazon Organizations 的查询 API 可以调用服务操作。查询 API 请求是 HTTPS 请求,必须包含 Action
参数,以指示要执行的操作。Amazon Organizations 支持所有操作的 GET 和 POST 请求。也就是说,API 不要求您使用某些操作的 GET 请求和其他操作的 POST 请求。然而,GET 请求受 URL 的大小限制。尽管此限制与浏览器相关,不过通常为 2048 字节。因此,对于要求更高的查询 API 请求,您必须使用 POST 请求。
响应是 XML 文档。有关响应的详细信息,请参阅 Amazon Organizations API 参考中的各个操作页面。
端点
Amazon Organizations 有一个在美国东部(弗吉尼亚北部)区域托管的全局 API 终端节点。
有关所有服务的 Amazon 端点和区域的更多信息,请参阅《Amazon Web Services 一般参考》中的 Regional endpoints。
必须使用 HTTPS
由于查询 API 返回安全凭证等敏感信息,必须使用 HTTPS 对所有 API 请求加密。
签署 Amazon Organizations API 请求
必须使用访问密钥 ID 和秘密访问密钥签署请求。我们强烈建议您不要使用 Amazon Web Services 账户根用户 凭证处理日常的 Amazon Organizations 工作。您可以使用用户或角色的凭证。
要对您的 API 请求进行签名,您必须使用 Amazon 签名版本 4。有关 Signature Version 4 的信息,请参阅《IAM 用户指南》中的签署 Amazon API 请求。
Amazon Organizations 不支持早期版本,例如签名版本 2。
有关更多信息,请参阅下列内容:
-
Amazon 安全凭证:提供有关可用于访问 Amazon 的凭证类型的一般信息。
-
IAM 中的安全最佳实践:提供有关使用 IAM 服务的建议,以帮助您保护您的 Amazon 资源,包括 Amazon Organizations 中的资源。
-
IAM 中的临时安全凭证:说明如何创建和使用临时安全凭证。