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

CPFS ファイルシステムのデータフローを照会します。

操作説明

データフローは、CPFS 2.2.0 以降、および CPFS for Lingjun 2.4.0 以降のバージョンでのみサポートされます。バージョン情報は、コンソールのファイルシステムの詳細ページで確認できます。
フィルターキー (Filters) のうち、FsetIds、DataFlowIds、SourceStorage、ThroughputList、Status は完全一致検索が必要です。FileSystemPath、Description、SourceStoragePath はあいまい一致検索をサポートしています。
組み合わせクエリをサポートしています。

今すぐお試しください

この 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:DescribeDataFlows

list

*DataFlow

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID。 CPFS ファイルシステムの ID は `cpfs-` で始まる必要があります。例：cpfs-125487**。 CPFS for Lingjun ファイルシステムの ID は `bmcpfs-` で始まる必要があります。例：bmcpfs-0015**。	cpfs-099394bd928c****
Filters	array<object>	任意	データフローの照会に使用するフィルター。
	object	任意
Key	string	任意	フィルター名。有効な値： DataFlowIds：データフロー ID に基づいてデータフロータスクをフィルターします。 FsetIds：ファイルセット ID に基づいてデータフローをフィルターします。 FileSystemPath：CPFS ファイルシステム内のファイルセットのパスに基づいてデータフローをフィルターします。 SourceStorage：ソースストレージのアクセスパスに基づいてデータフローをフィルターします。 ThroughputList：データフロースループットに基づいてデータフローをフィルターします。 Description：ファイルセットの説明に基づいてデータフローをフィルターします。 Status：データフローのステータスに基づいてデータフローをフィルターします。	FsetIds
Value	string	任意	フィルターの値。このパラメーターはワイルドカードをサポートしていません。 Key が DataFlowIds に設定されている場合、Value をデータフロー ID またはデータフロー ID の一部に設定します。データフロー ID またはデータフロー ID のグループを指定できます。最大 10 個のデータフロー ID を指定できます。例：`df-194433a5be31**` または `df-194433a512a2,df-234533a5be31`。 Key が FsetIds に設定されている場合、Value をファイルセット ID またはファイルセット ID の一部に設定します。ファイルセット ID またはファイルセット ID のグループを指定できます。最大 10 個のファイルセット ID を指定できます。例：`fset-1902718ea0ae` または `fset-235718ea0ae,fset-5122718ea0ae**`。 Key が FileSystemPath に設定されている場合、Value を CPFS ファイルシステム内のファイルセットのパスまたはパスの一部に設定します。パラメーターの値は 1～1,024 文字である必要があります。 Key が SourceStorage に設定されている場合、Value をソースストレージのアクセスパスまたはアクセスパスの一部に設定します。パスは最大 1,024 文字です。 Key が ThroughputList に設定されている場合、Value をデータフロースループットに設定します。組み合わせクエリがサポートされています。 Key が Description に設定されている場合、Value をデータフローの説明またはデータフローの説明の一部に設定します。 Key が Status に設定されている場合、Value をデータフローのステータスに設定します。 Key が SourceStoragePath に設定されている場合、Value をソースストレージのアクセスパスまたはアクセスパスの一部に設定します。パスは最大 1,024 文字です。	FsetIds
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークンです。最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	任意	各クエリの結果数。有効値：10～100。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	2D69A58F-345C-4FDE-88E4-BF518948****
NextToken	string	ページネーショントークン。次のリクエストで使用して、結果の新しいページを取得できます。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
DataFlowInfo	object
DataFlow	array<object>	データフローの詳細。
	array<object>
FileSystemId	string	ファイルシステムの ID。	cpfs-099394bd928c****
DataFlowId	string	データフローの ID。	df-194433a5be31****
FsetId	string	ファイルセット ID。説明このパラメーターは CPFS のみがサポートします。	fset-1902718ea0ae****
Status	string	データフローのステータス。次の情報が表示されます： Starting：データフローが作成中または有効化中です。 Running：データフローが作成され、正常に実行されています。 Updating：データフローが変更中です。たとえば、データフロースループットの増加や自動更新間隔の変更などです。 Deleting：データフローが削除中です。 Stopping：データフローが無効化中です。 Stopped：データフローが無効になりました。 Misconfigured：データフローの構成が異常です。たとえば、ソースストレージにアクセスできない、データフロースループットが低いために自動更新が完了できないなどです。	Running
ErrorMessage	string	エラーメッセージ。有効な値： None (デフォルト)：データフローのステータスは正常です。 SourceStorageUnreachable：ソースストレージのアクセスパスが見つかりません。 ThroughputTooLow：データフロースループットが低すぎます。	SourceStorageUnreachable
SourceStorage	string	ソースストレージのアクセスパス。フォーマット：`<ストレージタイプ>://[<アカウント ID>:]<パス>`。各項目は次のとおりです： storage type：OSS のみがサポートされます。 account id：ソースストレージのアカウントの UID。 path：OSS バケットの名前。名前には小文字、数字、ハイフン (-) のみを含めることができます。名前は小文字または数字で始まり、終わる必要があります。名前は 8～128 文字である必要があります。 UTF-8 でエンコードする必要があります。名前は http:// または https:// で始めることはできません。説明 OSS バケットは、リージョン内に存在する既存のバケットである必要があります。 CPFS for Lingjun V2.6.0 以降のみが account id パラメーターをサポートします。	oss://178321033379****:bucket-01
SourceSecurityType	string	ソースストレージのセキュリティメカニズムのタイプ。ソースストレージにセキュリティメカニズムを使用してアクセスする場合、このパラメーターを指定する必要があります。有効な値： Null (デフォルト)：OSS バケットにはセキュリティメカニズムなしでアクセスできます。 SSL：ソースストレージには SSL 証明書を使用してアクセスする必要があります。	SSL
Throughput	integer	データフローの最大スループット。単位：MB/s。有効な値： 600 1200 1500 説明データフロースループットは、ファイルシステムの I/O スループット未満である必要があります。このパラメーターは CPFS のみがサポートします。	600
Description	string	データフローの説明。使用制限：名前は 2～128 文字である必要があります。文字で始まる必要がありますが、`http://` または `https://` で始めることはできません。名前には、数字、文字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。	Bucket01数据流动
CreateTime	string	ファイルセットが作成された時刻。時刻は、`yyyy-MM-ddTHH:mm:ssZ` 形式の ISO 8601 標準に従います。説明このパラメーターは CPFS のみがサポートします。	2021-09-30T10:08:08Z
UpdateTime	string	ファイルセットが最後に更新された時刻。時刻は、`yyyy-MM-ddTHH:mm:ssZ` 形式の ISO 8601 標準に従います。説明このパラメーターは CPFS のみがサポートします。	2021-09-30T10:08:08Z
AutoRefresh	object
AutoRefresh	array<object>	自動更新ポリシーの詳細。説明このパラメーターは CPFS のみがサポートします。
	object
RefreshPath	string	自動更新ディレクトリ。CPFS は、ディレクトリ内のソースデータのみが更新されているかどうかを自動的にチェックし、更新されたデータをインポートします。使用制限：ディレクトリは 2～1,024 文字である必要があります。ディレクトリは UTF-8 でエンコードする必要があります。ディレクトリはスラッシュ (/) で始まり、終わる必要があります。説明ディレクトリは、CPFS ファイルシステムに存在する既存のディレクトリであり、データフローが有効になっているファイルセット内にある必要があります。	/prefix1/prefix2/
FileSystemPath	string	CPFS ファイルシステム内のファイルセットのディレクトリ。使用制限：ディレクトリは 2～1024 文字である必要があります。ディレクトリは UTF-8 でエンコードする必要があります。ディレクトリはスラッシュ (/) で始まり、終わる必要があります。ディレクトリは、CPFS ファイルシステム内のファイルセットディレクトリである必要があります。説明 CPFS のみがサポートされます。	/a/b/c/
FsetDescription	string	自動更新の説明。説明このパラメーターは CPFS のみがサポートします。	自动更新01
AutoRefreshInterval	integer	自動更新間隔。CPFS は、このパラメーターで指定された間隔でディレクトリ内のデータが更新されているかどうかをチェックします。データが更新されている場合、CPFS は自動更新タスクを開始します。単位：分。有効値：5～526600。デフォルト値：10。説明このパラメーターは CPFS のみがサポートします。	10
AutoRefreshPolicy	string	自動更新ポリシー。ソースストレージ内の更新されたデータは、ポリシーに基づいて CPFS ファイルシステムにインポートされます。次の情報が表示されます： None：ソースストレージ内の更新されたデータは、CPFS ファイルシステムに自動的にインポートされません。データフロータスクを実行して、ソースストレージから更新されたデータをインポートできます。 ImportChanged：ソースストレージ内の更新されたデータは、CPFS ファイルシステムに自動的にインポートされます。説明 CPFS のみがサポートされます。	None
SourceStoragePath	string	ソースストレージのバケット内のアクセスパス。説明このパラメーターは CPFS for Lingjun のみがサポートします。	/prefix/

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "DataFlowInfo": {
    "DataFlow": [
      {
        "FileSystemId": "cpfs-099394bd928c****",
        "DataFlowId": "df-194433a5be31****",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "Running",
        "ErrorMessage": "SourceStorageUnreachable",
        "SourceStorage": "oss://178321033379****:bucket-01",
        "SourceSecurityType": "SSL",
        "Throughput": 600,
        "Description": "Bucket01数据流动",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "AutoRefresh": {
          "AutoRefresh": [
            {
              "RefreshPath": "/prefix1/prefix2/"
            }
          ]
        },
        "FileSystemPath": "/a/b/c/",
        "FsetDescription": "自动更新01",
        "AutoRefreshInterval": 10,
        "AutoRefreshPolicy": "None",
        "SourceStoragePath": "/prefix/\n"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.
404	InvalidFilterValue	The specified parameter Filter.1.Value is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invalid.

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

変更履歴

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