ApplyDataFlowAutoRefresh - Cloud Parallel File Storage - Alibaba Cloud ドキュメントセンター

指定されたデータフローの自動更新を構成します。

操作説明

この操作は、Cloud Parallel File Storage (CPFS) ファイルシステムにのみ適用されます。
CPFS 2.2.0 以降のみがデータフローをサポートしています。バージョン情報はコンソールのファイルシステム詳細ページで確認できます。
自動リフレッシュ構成は、Running 状態のデータフローに対してのみ追加できます。
データフローに対して最大 5 つの自動リフレッシュ構成を追加できます。
自動リフレッシュ構成の作成には 2 ～ 5 分かかります。 DescribeDataFlows を呼び出してデータフローのステータスをクエリできます。
自動リフレッシュは、ソース OSS ストレージからオブジェクト変更イベントを収集するために EventBridge に依存しています。続行する前に EventBridge を有効化してください。

説明
CPFS が EventBridge に作成するイベントバスとイベントルールには、Create for cpfs auto refresh という説明が含まれています。これらのイベントバスやイベントルールを変更または削除しないでください。変更または削除すると、自動リフレッシュが正常に動作しなくなります。
自動リフレッシュは、RefreshPath パラメーターで指定されたプレフィックスを対象とします。CPFS データフローでプレフィックスの自動リフレッシュを構成すると、ユーザー側にイベントバスが作成され、ソース OSS バケットのプレフィックスに対してイベントルールが作成されます。ソース OSS バケットのプレフィックス内のオブジェクトが変更されると、EventBridge で OSS イベントが生成され、CPFS データフローによって処理されます。
自動リフレッシュ (AutoRefresh) を構成すると、ソースストレージでデータが変更された場合、変更済みのメタデータが CPFS ファイルシステムに自動的に同期されます。変更済みのデータは、ユーザーがファイルにアクセスしたときにオンデマンドでロードされるか、データフローノードを起動してデータをロードすることでロードされます。
更新間隔 (AutoRefreshInterval) は、CPFS がソース OSS バケットのプレフィックスにデータ更新が存在するかどうかを確認する間隔を指定します。データ更新が存在する場合、自動リフレッシュノードが起動されます。ソース OSS バケットでのオブジェクト変更イベントの頻度が CPFS データフローの処理能力を超えると、自動同期ノードが蓄積され、メタデータの更新が遅延し、データストリームのステータスが Misconfigured に変わります。この問題を解決するには、データストリームのスペックアップを行うか、OSS での変更頻度を減らしてください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nas:ApplyDataFlowAutoRefresh

update

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#fileSystemId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID。	cpfs-099394bd928c****
DataFlowId	string	必須	データフローの ID。	df-194433a5be31****
AutoRefreshs	array<object>	必須	自動リフレッシュ構成のコレクション。
	object	任意
RefreshPath	string	必須	自動リフレッシュディレクトリ。CPFS はソース上のこのディレクトリのデータが更新されたかどうかを自動的に確認し、更新されたデータをインポートします。使用制限: パスの長さは 2 ～ 1,024 文字である必要があります。パスは UTF-8 でエンコードされている必要があります。パスはフォワードスラッシュ (/) で始まり、フォワードスラッシュ (/) で終わる必要があります。説明ディレクトリは CPFS に既に存在し、データフローが有効になっているファイルセット内にある必要があります。	/prefix1/prefix2/
AutoRefreshPolicy	string	任意	自動リフレッシュポリシー。このポリシーは、ソースからのデータ更新を CPFS にインポートする方法を決定します。有効な値: None: ソースからのデータ更新は CPFS に自動的にインポートされません。データフロータスクを使用してソースからデータ更新をインポートできます。 ImportChanged: ソースからのデータ更新は CPFS に自動的にインポートされます。列挙値: ImportChanged : ソースからのデータ更新は CPFS に自動的にインポートされます。 None : ソースからのデータ更新は CPFS に自動的にインポートされません。	None
AutoRefreshInterval	integer	任意	更新間隔。CPFS はこの間隔でディレクトリのデータ更新を確認します。データ更新が存在する場合、自動リフレッシュタスクが起動されます。単位: 分。有効な値: 10 ～ 525600。デフォルト値: 10。	10
DryRun	boolean	任意	このリクエストに対してドライランを実行するかどうかを指定します。ドライランは、実際にインスタンスを作成したり料金を発生させたりすることなく、パラメーターの有効性とリソースの可用性を確認します。有効な値: true: インスタンスを作成せずにドライランリクエストを送信します。確認項目には、必須パラメーター、リクエストフォーマット、ビジネス制限、NAS 在庫が含まれます。確認に失敗した場合、対応するエラーが返されます。確認に成功した場合、HTTP 状態コード 200 が返されますが、FileSystemId は空です。 false (デフォルト): 通常のリクエストを送信します。確認に成功すると、インスタンスが作成されます。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。トークンには ASCII 文字のみを含めることができ、64 文字を超えることはできません。詳細については、べき等性の確保方法を参照してください。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API リクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	98696EF0-1607-4E9D-B01D-F20930B6****

例

成功レスポンス

JSONJSON

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingDataFlowId	DataFlowId is mandatory for this action.
403	OperationDenied.InvalidState	The operation is not permitted when the status is processing.
403	InvalidFileSystem.AlreadyExisted	The specified file system already exists.
403	OperationDenied.DependencyViolation	The operation is denied due to dependancy violation.
403	OperationDenied.NestedDir	The operation is denied due to nested directory.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidDataFlow.NotFound	The specified data flow does not exist.
404	InvalidRefreshPath.InvalidParameter	Refresh path is invalid.
404	InvalidRefreshPath.NotFound	Refresh path does not exist.
404	InvalidRefreshPolicy.InvalidParameter	Refresh policy is invalid.
404	InvalidRefreshInterval.OutOfBounds	Refresh interval is out of bounds.
404	InvalidRefreshPath.AlreadyExist	The refresh path already exists.
404	InvalidRefreshPath.TooManyPaths	The number of refresh paths exceeds the limit.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。