本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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 号。如果不指定此参数,则它默认为用于调用操作Amazon Web Services 账户的身份。要使用此参数,呼叫者必须是组织管理账户或委托管理员账户中的呼叫者。指定的账户 ID 还必须是同一组织中的成员账户。组织必须启用所有功能,并且组织必须为账户管理服务启用可信访问权限,并可选择分配委托管理员帐户。
注意
管理账户无法指定自己的账户
AccountId
。它必须通过不包含AccountId
参数在独立上下文中调用该操作。要对非作为组织成员的账户调用此操作,请不指定此参数。取而代之的是,使用属于您要检索或修改其联系人的账户的身份来调用该操作。
类型:字符串
模式:
^\d{12}$
必需:否
- MaxResults
-
命令输出中要返回的项目总数。如果可用项目总数大于指定值,则命令的输出中会提供 a
NextToken
。要恢复分页,请在后续命令的starting-token
参数中提供NextToken
值。不要直接在 Amazon CLI 之外使用NextToken
响应元素。有关用法示例,请参阅《Amazon命令行界面用户指南》中的分页。类型:整数
有效范围:最小值为 1。最大值为 50。
必需:否
- NextToken
-
用于指定开始分页的标记。这是
NextToken
来自先前截断的响应。有关用法示例,请参阅《Amazon命令行界面用户指南》中的分页。类型:字符串
长度限制:最小长度为 0。最大长度为 1000。
必需:否
- RegionOptStatusContains
-
区域状态列表(启用、启用、禁用、禁用、enabled_by_Default),用于筛选给定账户的区域列表。例如,传入 ENABLING 值将仅返回区域状态为 ENABLING 的区域列表。
类型:字符串数组
有效值:
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 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: