本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
GetRegionOptStatus
擷取特定區域的選擇加入狀態。
請求語法
POST /getRegionOptStatus HTTP/1.1
Content-type: application/json
{
"AccountId": "string",
"RegionName": "string"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- AccountId
-
指定您要透過此操作存取或修改之 AWS 帳戶 的 12 位數帳戶 ID 號碼。如果您未指定此參數,它會預設為用於呼叫 操作之身分的 Amazon Web Services 帳戶。若要使用此參數,發起人必須是組織管理帳戶或委派管理員帳戶中的身分。指定的帳戶 ID 必須是相同組織中的成員帳戶。組織必須啟用所有功能,且組織必須針對帳戶管理服務啟用信任存取,並選擇性地指派委派的管理員帳戶。
注意
管理帳戶無法指定自己的
AccountId。它必須藉由不包含AccountId參數,在獨立內容中呼叫 操作。若要在非組織成員的帳戶上呼叫此操作,請勿指定此參數。反之,請使用屬於您想要擷取或修改其聯絡人之帳戶的身分來呼叫 操作。
類型:字串
模式:
\d{12}必要:否
- RegionName
-
指定指定區域名稱的區域代碼 (例如,
af-south-1)。此函數將傳回您傳遞至此參數的任何區域的狀態。類型:字串
長度限制:長度下限為 1。長度上限為 50。
必要:是
回應語法
HTTP/1.1 200
Content-type: application/json
{
"RegionName": "string",
"RegionOptStatus": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- RegionName
-
傳入的區域碼。
類型:字串
長度限制:長度下限為 1。長度上限為 50。
- RegionOptStatus
-
區域可以經歷的可能狀態之一 (啟用、啟用、停用、停用、Enabled_By_Default)。
類型:字串
有效值:
ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- AccessDeniedException
-
操作失敗,因為呼叫身分沒有所需的最低許可。
- errorType
-
API Gateway 填入
x-amzn-ErrorType回應標頭的值。
HTTP 狀態碼:403
- InternalServerException
-
由於 內部發生錯誤,操作失敗 AWS。請稍後重試您的操作。
- errorType
-
API Gateway 填入
x-amzn-ErrorType回應標頭的值。
HTTP 狀態碼:500
- TooManyRequestsException
-
操作失敗,因為呼叫次數太頻繁且超過節流限制。
- errorType
-
API Gateway 填入
x-amzn-ErrorType回應標頭的值。
HTTP 狀態碼:429
- ValidationException
-
操作失敗,因為其中一個輸入參數無效。
- fieldList
-
偵測到無效項目的欄位。
- message
-
通知您有關請求無效內容的訊息。
- reason
-
驗證失敗的原因。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: