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: `cpfs-` で始まる必要があります (例: cpfs-125487**)。 CPFS for Lingjun: `bmcpfs-` で始まる必要があります (例: bmcpfs-0015**)。	cpfs-099394bd928c****
Filters	array<object>	任意	データフローをクエリするためのフィルターキー。
	object	任意
Key	string	任意	フィルターキーの名前。有効な値: DataFlowIds: データフロー ID でフィルターします。 FsetIds: Fileset ID でフィルターします。 FileSystemPath: CPFS ファイルシステム内の Fileset のパスでフィルターします。 SourceStorage: ソースストレージのアクセスパスでフィルターします。 ThroughputList: データフローの伝送帯域幅でフィルターします。 Description: Fileset の説明でフィルターします。 Status: データフローのステータスでフィルターします。列挙値: FileSystemPath : CPFS ファイルシステム内の Fileset のパスでフィルターします。 Status : データフローのステータスでフィルターします。 SourceStorage : ソースストレージのアクセスパスでフィルターします。 Description : Fileset の説明でフィルターします。 SourceStoragePath : ソースストレージのアクセスパスでフィルターします。 ThroughputList : データフローの伝送帯域幅でフィルターします。 DataFlowIds : データフロー ID でフィルターします。 FsetIds : Fileset ID でフィルターします。	FsetIds。
Value	string	任意	フィルターキーの値。このパラメーターではワイルドカードはサポートされていません。 Key が DataFlowIds にセットされている場合、Value にはデータフロー ID またはデータフロー ID の一部をセットします。1 つ以上のデータフロー ID を指定できます。最大値は 10 個のデータフロー ID です。例: `df-194433a5be31**` または `df-194433a512a2,df-234533a5be31`。 Key が FsetIds にセットされている場合、Value には Fileset ID または Fileset ID の一部をセットします。1 つ以上の Fileset ID を指定できます。最大値は 10 個の Fileset ID です。例: `fset-1902718ea0ae` または `fset-235718ea0ae,fset-5122718ea0ae**`。 Key が FileSystemPath にセットされている場合、Value には CPFS ファイルシステム内のパスまたはパスの一部をセットします。値の長さは 1～1024 文字である必要があります。 Key が SourceStorage にセットされている場合、Value にはソースストレージのアクセスパスをセットします。最大長は 1024 文字です。 Key が ThroughputList にセットされている場合、Value にはデータフローの伝送帯域幅をセットします。複合クエリがサポートされています。 Key が Description にセットされている場合、Value にはデータフローの説明または説明の一部をセットします。 Key が Status にセットされている場合、Value にはデータフローのステータスをセットします。 Key が SourceStoragePath にセットされている場合、Value にはソースストレージのアクセスパスまたはアクセスパスの一部をセットします。最大長は 1024 文字です。	FsetIds。
NextToken	string	任意	次のリクエストで結果の新しいページを取得するために使用されるページネーショントークン。返された結果が切り捨てられている場合は、NextToken を使用して切り捨てポイントからコンテンツを取得します。	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	任意	各クエリの結果の数。有効な値: 10～100。デフォルト値: 20。	20

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "DataFlowInfo": {
    "DataFlow": [
      {
        "FileSystemId": "cpfs-099394bd928c****",
        "DataFlowId": "df-194433a5be31****",
        "Description": "Bucket01 データフロー。",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "Status": "Running。",
        "ErrorMessage": "SourceStorageUnreachable。",
        "SourceSecurityType": "SSL。",
        "SourceStorage": "oss://178321033379****:バケット-01",
        "SourceStoragePath": "/prefix/",
        "FsetId": "fset-1902718ea0ae****",
        "FsetDescription": "AutoUpdate01",
        "FileSystemPath": "/a/b/c/",
        "AutoRefresh": {
          "AutoRefresh": [
            {
              "RefreshPath": "/prefix1/prefix2/"
            }
          ]
        },
        "AutoRefreshPolicy": "None。",
        "AutoRefreshInterval": 10,
        "Throughput": 600
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalCharacters	The parameter contains illegal characters.	指定されたパラメーターが無効です。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	FileSystemId パラメーターが指定されていません。
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.	指定された Filter.N.Key パラメーターが無効です。
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定された MaxResults が無効です。
404	InvalidParameter.InvalidNextToken	The specified NextToken is invalid.	指定された NextToken が無効です。

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

変更履歴

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