其他 Neptune API - Amazon Neptune

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

其他 Neptune API

動作:

結構:

AddTagsToResource (動作)

        此 API 的 AWS CLI 名稱是:add-tags-to-resource

將中繼資料標籤新增到 Amazon Neptune 資源。這些標籤也可以搭配成本分配報告,用來追蹤與 Amazon Neptune 資源相關聯的成本,或用在 Amazon Neptune 之 IAM 政策的條件陳述式中。

請求

  • ResourceName (在 CLI 中:--resource-name) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    要新增標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊,請參閱建構 Amazon Resource Name (ARN)

  • Tags (在 CLI 中:--tags) – 必要:Tag 物件的陣列。

    要指派給 Amazon Neptune 資源的標籤。

回應
  • 無回應參數。

ListTagsForResource (動作)

        此 API 的 AWS CLI 名稱是:list-tags-for-resource

列出 Amazon Neptune 資源的所有標籤。

請求

  • Filters (在 CLI 中:--filters) – 篩選條件 物件的陣列。

    目前不支援此參數。

  • ResourceName (在 CLI 中:--resource-name) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    具有要列出之標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊,請參閱建構 Amazon Resource Name (ARN)

回應

  • TagList – 一個 Tag 物件陣列。

    ListTagsForResource 操作傳回的標籤清單。

RemoveTagsFromResource (動作)

        此 API 的 AWS CLI 名稱是:remove-tags-from-resource

移除 Amazon Neptune 資源中的中繼資料標籤。

請求

  • ResourceName (在 CLI 中:--resource-name) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    要移除標籤的 Amazon Neptune 資源。這個值是 Amazon Resource Name (ARN)。如需建立 ARN 的資訊,請參閱建構 Amazon Resource Name (ARN)

  • TagKeys (在 CLI 中:--tag-keys) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    要移除之標籤的標籤金鑰 (名稱)。

回應
  • 無回應參數。

ApplyPendingMaintenanceAction (動作)

        此 API 的 AWS CLI 名稱是:apply-pending-maintenance-action

將待處理維護動作套用到資源 (例如,資料庫執行個體)。

請求

  • ApplyAction (在 CLI 中:--apply-action) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    要套用至此資源的待處理維護動作。

    有效值:system-updatedb-upgrade

  • OptInType (在 CLI 中:--opt-in-type) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    值,指定選擇使用請求的類型,或復原選擇使用請求。無法復原 immediate 類型的選擇使用請求。

    有效值:

    • immediate - 立即套用維護動作。

    • next-maintenance - 在下次資源維護時段期間套用維護動作。

    • undo-opt-in - 取消任何現有的 next-maintenance 選擇使用請求。

  • ResourceIdentifier (在 CLI 中:--resource-identifier) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    要套用待處理維護動作之資源的 Amazon Resource Name (ARN)。如需建立 ARN 的資訊,請參閱建構 Amazon Resource Name (ARN)

回應

描述資源的待處理維護動作。

  • PendingMaintenanceActionDetails – 一個 PendingMaintenanceAction 物件陣列。

    清單,提供資源待處理維護動作的詳細資訊。

  • ResourceIdentifier – 字串,類型為:string (UTF-8 編碼的字串)。

    具有待處理維護動作的資源 ARN。

DescribePendingMaintenanceActions (動作)

        此 API 的 AWS CLI 名稱是:describe-pending-maintenance-actions

傳回至少有一個待處理維護動作的資源清單 (例如,資料庫執行個體)。

請求

  • Filters (在 CLI 中:--filters) – 篩選條件 物件的陣列。

    篩選條件,指定傳回待處理維護動作的一或多種資源。

    支援的篩選條件:

    • db-cluster-id - 接受資料庫叢集識別符及資料庫叢集 Amazon Resource Name (ARN)。結果清單只包含這些 ARN 找到的資料庫叢集待處理維護動作。

    • db-instance-id - 接受資料庫執行個體識別符和資料庫執行個體 ARN。結果清單只包含這些 ARN 找到的資料庫執行個體待處理維護動作。

  • Marker (在 CLI 中:--marker) – 字串,類型為:string (UTF-8 編碼的字串)。

    前一個 DescribePendingMaintenanceActions 請求提供的選用分頁字符。如已指定此參數,則回應僅包含超出標記的記錄,不超過 MaxRecords 指定的記錄數量。

  • MaxRecords (在 CLI 中:--max-records) – IntegerOptional,類型為:integer (帶正負號的 32 位元整數)。

    要在回應中包含的記錄數量上限。若存在的記錄比 MaxRecords 值指定的更多,則稱為「標記」的分頁字符會包含在回應中,讓您可以擷取剩餘的結果。

    預設:100

    限制條件:最小 20,最大 100。

  • ResourceIdentifier (在 CLI 中:--resource-identifier) – 字串,類型為:string (UTF-8 編碼的字串)。

    傳回待處理維護動作的資源 ARN。

回應

  • Marker – 字串,類型為:string (UTF-8 編碼的字串)。

    前一個 DescribePendingMaintenanceActions 請求提供的選用分頁字符。如已指定此參數,則回應僅包含超出標記的記錄,不超過 MaxRecords 指定的記錄數量。

  • PendingMaintenanceActions – 一個 ResourcePendingMaintenanceActions 物件陣列。

    資源的待處理維護動作清單。

DescribeDBEngineVersions (動作)

        此 API 的 AWS CLI 名稱是:describe-db-engine-versions

傳回可用的資料庫引擎清單。

請求

  • DBParameterGroupFamily (在 CLI 中:--db-parameter-group-family) – 字串,類型為:string (UTF-8 編碼的字串)。

    要傳回詳細資訊的特定資料庫參數群組系列名稱。

    約束:

    • 如果提供,則必須符合現有的 DBParameterGroupFamily。

  • DefaultOnly (在 CLI 中:--default-only) – 布林值,類型為:boolean (布林值 (true 或 false))。

    指出只會傳回指定引擎或引擎預設版本和主要版本的組合。

  • Engine (在 CLI 中:--engine) – 字串,類型為:string (UTF-8 編碼的字串)。

    要傳回的資料庫引擎。

  • EngineVersion (在 CLI 中:--engine-version) – 字串,類型為:string (UTF-8 編碼的字串)。

    要傳回的資料庫引擎版本。

    範例:5.1.49

  • Filters (在 CLI 中:--filters) – 篩選條件 物件的陣列。

    目前不支援。

  • ListSupportedCharacterSets (在 CLI 中:--list-supported-character-sets) – BooleanOptional,類型為:boolean (布林值 (true 或 false))。

    如已指定此參數,而請求的引擎支援 CreateDBInstanceCharacterSetName 參數,則回應會包含每個引擎版本支援的字元集清單。

  • ListSupportedTimezones (在 CLI 中:--list-supported-timezones) – BooleanOptional,類型為:boolean (布林值 (true 或 false))。

    如已指定此參數,而請求的引擎支援 CreateDBInstanceTimeZone 參數,則回應會包含每個引擎版本支援的時區清單。

  • Marker (在 CLI 中:--marker) – 字串,類型為:string (UTF-8 編碼的字串)。

    前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到 MaxRecords 指定的值為止。

  • MaxRecords (在 CLI 中:--max-records) – IntegerOptional,類型為:integer (帶正負號的 32 位元整數)。

    要在回應中包含的記錄數量上限。如有 MaxRecords 以上的值可用,則稱為標記的分頁字符會包含在回應中,以便擷取下列結果。

    預設:100

    限制條件:最小 20,最大 100。

回應

  • DBEngineVersions – 一個 DBEngineVersion 物件陣列。

    DBEngineVersion 元素的清單。

  • Marker – 字串,類型為:string (UTF-8 編碼的字串)。

    前一個請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到 MaxRecords 指定的值為止。

結構:

DBEngineVersion (結構)

此資料類型在 DescribeDBEngineVersions (動作) 動作中會用來作為回應元素。

欄位
  • DBEngineDescription - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎描述。

  • DBEngineVersionDescription - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎版本描述。

  • DBParameterGroupFamily - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎的資料庫參數群組系列名稱。

  • Engine - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎名稱。

  • EngineVersion - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎版本編號。

  • ExportableLogTypes - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫引擎能提供匯出到 CloudWatch Logs 的日誌類型。

  • SupportedTimezones - 這是 時區 物件的陣列。

    此引擎針對 CreateDBInstance 動作之 Timezone 參數支援的時區清單。

  • SupportsGlobalDatabases - 這是布林值,類型為:boolean (布林值 (true 或 false))。

    一值,指示您是否可以使用 Aurora 全球資料庫,搭配特定的資料庫引擎版本。

  • SupportsLogExportsToCloudwatchLogs - 這是布林值,類型為:boolean (布林值 (true 或 false))。

    值,指出引擎版本是否支援將 ExportableLogTypes 提定的日誌類型匯出到 CloudWatch Logs。

  • SupportsReadReplica - 這是布林值,類型為:boolean (布林值 (true 或 false))。

    指出資料庫引擎版本是否支援僅供讀取複本。

  • ValidUpgradeTarget - 這是 UpgradeTarget 物件的陣列。

    此資料庫引擎版本可升級的引擎版本清單。

EngineDefaults (結構)

包含成功呼叫 DescribeEngineDefaultParameters (動作) 動作的結果。

欄位
  • DBParameterGroupFamily - 這是字串,類型為:string (UTF-8 編碼的字串)。

    指定要套用引擎預設參數的資料庫參數群組系列名稱。

  • Marker - 這是字串,類型為:string (UTF-8 編碼的字串)。

    前一個 EngineDefaults 請求提供的選用分頁字符。若指定此參數,則回應只會包含超過標記的記錄,直到 MaxRecords 指定的值為止。

  • Parameters - 這是 參數 物件的陣列。

    包含引擎預設參數的清單。

EngineDefaults 會用來做為以下項目的回應元素:

PendingMaintenanceAction (結構)

提供資源待處理維護動作的資訊。

欄位
  • Action - 這是字串,類型為:string (UTF-8 編碼的字串)。

    可供資源使用的待處理維護動作類型。

  • AutoAppliedAfterDate - 這是 TStamp,類型為:timestamp (一個時間點,通常定義為 1970-01-01 午夜的偏移量)。

    套用動作時的維護時段日期。維護動作會在此日期後的第一個維護時段中,套用到資源。如已指定此日期,則忽略任何 next-maintenance 選擇使用請求。

  • CurrentApplyDate - 這是 TStamp,類型為:timestamp (一個時間點,通常定義為 1970-01-01 午夜的偏移量)。

    待處理維護動作套用至資源時的有效日期。此日期會考慮從 ApplyPendingMaintenanceAction (動作) API、AutoAppliedAfterDateForcedApplyDate 收到的選擇使用請求。如未收到選擇使用請求,且沒有任何項目指定為 AutoAppliedAfterDateForcedApplyDate,則此值為空白。

  • Description - 這是字串,類型為:string (UTF-8 編碼的字串)。

    提供維護動作更多詳細資訊的描述。

  • ForcedApplyDate - 這是 TStamp,類型為:timestamp (一個時間點,通常定義為 1970-01-01 午夜的偏移量)。

    自動套用維護動作時的日期。維護動作會在此日期套用至資源,無論資源的維護時段為何。如已指定此日期,則忽略任何 immediate 選擇使用請求。

  • OptInStatus - 這是字串,類型為:string (UTF-8 編碼的字串)。

    指出資源已收到的選擇使用請求類型。

ResourcePendingMaintenanceActions (結構)

描述資源的待處理維護動作。

欄位
  • PendingMaintenanceActionDetails - 這是 PendingMaintenanceAction 物件的陣列。

    清單,提供資源待處理維護動作的詳細資訊。

  • ResourceIdentifier - 這是字串,類型為:string (UTF-8 編碼的字串)。

    具有待處理維護動作的資源 ARN。

ResourcePendingMaintenanceActions 會用來做為以下項目的回應元素:

UpgradeTarget (結構)

資料庫執行個體可升級的資料庫引擎版本。

欄位
  • AutoUpgrade - 這是布林值,類型為:boolean (布林值 (true 或 false))。

    值,指出目標版本是否套用到已將 AutoMinorVersionUpgrade 設定為 true 的任何來源資料庫執行個體。

  • Description - 這是字串,類型為:string (UTF-8 編碼的字串)。

    資料庫執行個體可升級的資料庫引擎版本。

  • Engine - 這是字串,類型為:string (UTF-8 編碼的字串)。

    升級目標資料庫引擎名稱。

  • EngineVersion - 這是字串,類型為:string (UTF-8 編碼的字串)。

    升級目標資料庫引擎的版本編號。

  • IsMajorVersionUpgrade - 這是布林值,類型為:boolean (布林值 (true 或 false))。

    值,指出資料庫引擎是否升級到主要版本。

  • SupportsGlobalDatabases – 這是 BooleanOptional,類型為:boolean (布林值 (true 或 false))。

    一值,指示您是否可以使用 Neptune 全球資料庫,搭配目標引擎版本。

Tag (結構)

中繼資料,指派給由金鑰/值對組成的 Amazon Neptune 資源。

欄位
  • Key - 這是字串,類型為:string (UTF-8 編碼的字串)。

    鍵是標籤的必要名稱。字串值長度可以是 1 到 128 個 Unicode 字元,不可在前面加上 aws:rds:。該字串僅能包含一組 Unicode 字母、數字、空格、「_」、「.」、「/」、「=」、「+」、「-」(Java regex:"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$")。

  • Value - 這是字串,類型為:string (UTF-8 編碼的字串)。

    值是標籤的選用值。字串值長度可以是 1 到 256 個 Unicode 字元,不可在前面加上 aws:rds:。該字串僅能包含一組 Unicode 字母、數字、空格、「_」、「.」、「/」、「=」、「+」、「-」(Java regex:"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$")。