本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListRegions
列出给定账户的所有区域及其各自的选择加入状态。也可以选择按 region-opt-status-contains
参数筛选此列表。
请求语法
POST /listRegions HTTP/1.1
Content-type: application/json
{
"AccountId": "string
",
"MaxResults": number
,
"NextToken": "string
",
"RegionOptStatusContains": [ "string
" ]
}
URI 请求参数
该请求不使用任何 URI 参数。
请求体
请求接受采用 JSON 格式的以下数据。
- AccountId
-
指定要通过此操作访问或修改的 Amazon Web Services 账户 账户的 12 位账户 ID 号。如果未指定此参数,则默认为调用此操作使用的身份的亚马逊云科技账户。要使用此参数,调用方必须具有组织管理账户或委托管理员账户中的身份。指定账户 ID 必须是同一组织内的成员账户。组织必须启用所有功能,且组织必须为账户管理服务启用可信访问权限,可选择分配委托管理员账户。
注意
管理账户无法指定自己的
AccountId
。它必须在不包括AccountId
参数的情况下,在独立上下文中调用此操作。要对不是组织成员的账户调用此操作,不要指定此参数。相反,请以属于要检索或修改其联系人的账户的身份调用此操作。
类型:字符串
模式:
^\d{12}$
必需:否
- MaxResults
-
命令的输出中要返回的项目总数。如果可用的总项目数超过指定的值,则命令的输出中会提供
NextToken
。要恢复分页,请在后续命令的starting-token
参数中提供NextToken
值。请勿在 Amazon CLI 之外直接使用NextToken
响应元素。有关用法示例,请参阅《Amazon 命令行用户指南》中的分页。类型:整数
有效范围:最小值为 1。最大值为 50。
必需:否
- NextToken
-
用于指定从何处开始分页的令牌。这是先前截断的响应中的
NextToken
。有关用法示例,请参阅《Amazon 命令行用户指南》中的分页。类型:字符串
长度约束:最小长度为 0。最大长度为 1000。
必需:否
- RegionOptStatusContains
-
区域状态列表(启用、已启用、禁用、已禁用、默认已启用),用于筛选给定账户的区域列表。例如,传入值为“启用”时将仅返回区域状态为“启用”的区域列表。
类型:字符串数组
有效值:
ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT
必需:否
响应语法
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Regions": [
{
"RegionName": "string",
"RegionOptStatus": "string"
}
]
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- AccessDeniedException
-
操作失败,调用身份没有所需的最低权限。
HTTP 状态代码:403
- InternalServerException
-
操作失败,Amazon 内部存在错误。请稍后重新尝试操作。
HTTP 状态代码:500
- TooManyRequestsException
-
操作失败,调用频率过高且超过了节流限制。
HTTP 状态代码:429
- ValidationException
-
操作失败,其中一个输入参数无效。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: