本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Neptune 子網路 API
動作:
結構:
CreateDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱是:create-db-subnet-group
。
建立新的資料庫子網路群組。資料庫子網路群組必須在 Amazon 區域中至少兩個可用區內包含一個子網路。
請求
-
DBSubnetGroupDescription (在 CLI 中:
--db-subnet-group-description
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的描述。
-
DBSubnetGroupName (在 CLI 中:
--db-subnet-group-name
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的名稱。此值會以小寫字母字串的形式儲存。
限制條件:包含的內容絕不能超過 255 個字母、數字、句號、底線、空格或連字號。絕不能為預設值。
範例:
mySubnetgroup
-
SubnetIds (在 CLI 中:
--subnet-ids
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的 EC2 子網路 ID。
-
Tags (在 CLI 中:
--tags
) – Tag 物件的陣列。要指派給新資料庫子網路群組的標籤。
回應
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 DescribeDBSubnetGroups (動作) 動作中會用來作為回應元素。
-
DBSubnetGroupArn – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的 Amazon Resource Name (ARN)。
-
DBSubnetGroupDescription – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的描述。
-
DBSubnetGroupName – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的名稱。
-
SubnetGroupStatus – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的狀態。
-
Subnets – 一個 子網 物件陣列。
包含 Subnet (結構) 元素的清單。
-
VpcId – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的 VpcId。
錯誤
DeleteDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱是:delete-db-subnet-group
。
刪除資料庫子網路群組。
注意
指定的資料庫子網路群組不能和任何資料庫執行個體建立關聯。
請求
-
DBSubnetGroupName (在 CLI 中:
--db-subnet-group-name
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。要刪除的資料庫子網路群組名稱。
注意
您無法刪除預設子網路群組。
約束:
限制條件:必須符合現有 DBSubnetGroup 的名稱。絕不能為預設值。
範例:
mySubnetgroup
回應
無回應參數。
ModifyDBSubnetGroup (動作)
此 API 的 AWS CLI 名稱是:modify-db-subnet-group
。
修改現有的資料庫子網路群組。資料庫子網路群組必須在 Amazon 區域中至少兩個可用區內包含一個子網路。
請求
-
DBSubnetGroupDescription (在 CLI 中:
--db-subnet-group-description
) – 字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的描述。
-
DBSubnetGroupName (在 CLI 中:
--db-subnet-group-name
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的名稱。此值會以小寫字母字串的形式儲存。您無法修改預設子網路群組。
限制條件:必須符合現有 DBSubnetGroup 的名稱。絕不能為預設值。
範例:
mySubnetgroup
-
SubnetIds (在 CLI 中:
--subnet-ids
) – 必要:字串,類型為:string
(UTF-8 編碼的字串)。資料庫子網路群組的 EC2 子網路 ID。
回應
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 DescribeDBSubnetGroups (動作) 動作中會用來作為回應元素。
-
DBSubnetGroupArn – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的 Amazon Resource Name (ARN)。
-
DBSubnetGroupDescription – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的描述。
-
DBSubnetGroupName – 字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的名稱。
-
SubnetGroupStatus – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的狀態。
-
Subnets – 一個 子網 物件陣列。
包含 Subnet (結構) 元素的清單。
-
VpcId – 字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的 VpcId。
錯誤
DescribeDBSubnetGroups (動作)
此 API 的 AWS CLI 名稱是:describe-db-subnet-groups
。
傳回 DBSubnetGroup 描述的清單。若指定 DBSubnetGroupName,則清單只會包含指定 DBSubnetGroup 的描述。
如需 CIDR 範圍的概觀,請前往 Wikipedia Tutorial
請求
-
DBSubnetGroupName (在 CLI 中:
--db-subnet-group-name
) – 字串,類型為:string
(UTF-8 編碼的字串)。要傳回其詳細資訊的資料庫子網路群組名稱。
-
Filters (在 CLI 中:
--filters
) – 篩選條件 物件的陣列。目前不支援此參數。
-
Marker (在 CLI 中:
--marker
) – 字串,類型為:string
(UTF-8 編碼的字串)。前一個 DescribeDBSubnetGroups 請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到
MaxRecords
指定的值為止。 -
MaxRecords (在 CLI 中:
--max-records
) – IntegerOptional,類型為:integer
(帶正負號的 32 位元整數)。要在回應中包含的記錄數量上限。若存在的記錄比
MaxRecords
值指定的更多,則稱為「標記」的分頁字符會包含在回應中,讓您可以擷取剩餘的結果。預設:100
限制條件:最小 20,最大 100。
回應
-
DBSubnetGroups – 一個 DBSubnetGroup 物件陣列。
DBSubnetGroup (結構) 執行個體的清單。
-
Marker – 字串,類型為:
string
(UTF-8 編碼的字串)。前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到
MaxRecords
指定的值為止。
結構:
Subnet (結構)
指定子網路。
此資料類型在 DescribeDBSubnetGroups (動作) 動作中會用來作為回應元素。
欄位
-
SubnetAvailabilityZone - 這是一個 AvailabilityZone 物件。
指定子網路所在的 EC2 可用區域。
-
SubnetIdentifier - 這是字串,類型為:
string
(UTF-8 編碼的字串)。指定子網路的識別符。
-
SubnetStatus - 這是字串,類型為:
string
(UTF-8 編碼的字串)。指定子網路的狀態。
DBSubnetGroup (結構)
包含 Amazon Neptune 子網路群組的詳細資訊。
此資料類型在 DescribeDBSubnetGroups (動作) 動作中會用來作為回應元素。
欄位
-
DBSubnetGroupArn - 這是字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的 Amazon Resource Name (ARN)。
-
DBSubnetGroupDescription - 這是字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的描述。
-
DBSubnetGroupName - 這是字串,類型為:
string
(UTF-8 編碼的字串)。資料庫子網路群組的名稱。
-
SubnetGroupStatus - 這是字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的狀態。
-
Subnets - 這是 子網 物件的陣列。
包含 Subnet (結構) 元素的清單。
-
VpcId - 這是字串,類型為:
string
(UTF-8 編碼的字串)。提供資料庫子網路群組的 VpcId。
DBSubnetGroup
會用來做為以下項目的回應元素: