API 標準および多言語対応の SDK
本製品 (NAS/2017-06-26) の API は、RPC 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。
カスタム署名
署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID:147535001692) までお問い合わせください。
はじめに
Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。
API セキュリティを確保するには、以下を作成し、設定する必要があります。
RAM ユーザー
RAM ユーザー用の AccessKey ペア
サービス操作
|
API |
タイトル |
説明 |
| OpenNASService | OpenNASService | NAS サービスを有効化します。 |
リージョン
|
API |
タイトル |
説明 |
| DescribeZones | DescribeZones | リージョン内のすべてのゾーンと、各ゾーンでサポートされているファイルシステムタイプを照会します。 |
| DescribeRegions | DescribeRegions | File Storage NAS が利用可能なリージョンを照会します。 |
ファイルシステム
|
API |
タイトル |
説明 |
| CreateFileSystem | CreateFileSystem | ファイルシステムを作成します。 |
| DeleteFileSystem | DeleteFileSystem | ファイルシステムを削除します。 |
| ModifyFileSystem | ModifyFileSystem | ファイルシステムの説明を変更します。 |
| DescribeFileSystems | ファイルシステム情報を照会します。 | ファイルシステム情報を照会します。 |
| UpgradeFileSystem | UpgradeFileSystem | 超高速型 NAS ファイルシステムまたはクラウド並列ファイルストレージ (CPFS) ファイルシステムを拡張します。 |
| DescribeFilesystemsAssociatedHpnZones | DescribeFilesystemsAssociatedHpnZones | ファイルシステムに関連付けられている HpnZones のリストを取得します。コンピューティングノードが関連付けられた HpnZones のいずれかに配置されている場合、アクセスパフォーマンスが最適になります。 |
マウントポイント
|
API |
タイトル |
説明 |
| CreateMountTarget | マウントターゲットの作成 | マウントターゲットを作成します。 |
| DeleteMountTarget | DeleteMountTarget | マウントポイントを削除します。 |
| ModifyMountTarget | ModifyMountTarget | マウントポイントのプロパティを変更します。 |
| DescribeMountTargets | DescribeMountTargets | マウントポイントに関する情報を取得します。 |
| DescribeMountedClients | DescribeMountedClients | ファイルシステムがマウントされているクライアントを照会します。 |
アクセスポイント
|
API |
タイトル |
説明 |
| CreateAccessPoint | アクセスポイントを作成します。 | アクセスポイントを作成します。 |
| ModifyAccessPoint | アクセスポイント情報を変更します。 | アクセスポイント情報を変更します。 |
| DescribeAccessPoints | アクセスポイント情報を照会します。 | アクセスポイント情報を照会します。 |
| DescribeAccessPoint | アクセスポイントの詳細を照会します。 | アクセスポイントの詳細を照会します。 |
| DeleteAccessPoint | DeleteAccessPoint | アクセスポイントを削除します。 |
| CreateDir | CreateDir | ファイルシステムにディレクトリを作成します。 |
権限グループ
|
API |
タイトル |
説明 |
| CreateAccessGroup | 権限グループを作成します | 権限グループを作成します。 |
| DeleteAccessGroup | アクセスグループを削除します | 既存のアクセスグループを削除します。 |
| ModifyAccessGroup | ModifyAccessGroup | 権限グループを変更します。 |
| DescribeAccessGroups | 権限グループ情報を照会します | 権限グループのフォーマット情報を照会します。 |
| CreateAccessRule | 権限ルールを作成します | 権限グループの権限ルールを作成します。 |
| DeleteAccessRule | 権限ルールを削除します | 権限グループから権限ルールを削除します。 |
| ModifyAccessRule | ModifyAccessRule | 権限グループ内のルールを変更します。 |
| DescribeAccessRules | DescribeAccessRules | 権限グループ内のルールに関する情報を照会します。 |
スナップショット
|
API |
タイトル |
説明 |
| CreateSnapshot | CreateSnapshot | スナップショットを作成します。 |
| DeleteSnapshot | スナップショットの削除または作成中のスナップショットタスクのキャンセル | 指定されたスナップショットを削除するか、作成中のスナップショットタスクをキャンセルします。 |
| DescribeSnapshots | DescribeSnapshots | 1 つ以上のファイルシステムのスナップショットに関する情報を照会します。 |
| CreateAutoSnapshotPolicy | 自動スナップショットポリシーを作成します | 自動スナップショットポリシーを作成します。 |
| DeleteAutoSnapshotPolicy | DeleteAutoSnapshotPolicy | 自動スナップショットポリシーを削除します。 |
| ModifyAutoSnapshotPolicy | ModifyAutoSnapshotPolicy | 自動スナップショットポリシーを変更します。ファイルシステムに適用されている自動スナップショットポリシーを変更すると、その変更は、そのファイルシステムに対して後続で作成されるスナップショットに直ちに適用されます。 |
| ApplyAutoSnapshotPolicy | ApplyAutoSnapshotPolicy | 1 つ以上のファイルシステムに自動スナップショットポリシーを適用します。 |
| CancelAutoSnapshotPolicy | 1 つ以上のファイルシステムの自動スナップショットポリシーをキャンセルします | ファイルシステムに作成された自動スナップショットポリシーをキャンセルします。 |
| DescribeAutoSnapshotPolicies | DescribeAutoSnapshotPolicies | 自動スナップショットポリシーを照会します。 |
| DescribeAutoSnapshotTasks | DescribeAutoSnapshotTasks | 自動スナップショットタスクを照会します。 |
| ResetFileSystem | ResetFileSystem | ファイルシステムをスナップショットにロールバックします。 |
タグ
|
API |
タイトル |
説明 |
| TagResources | TagResources | タグを作成し、ファイルシステムに関連付けます。 |
| UntagResources | UntagResources | ファイルシステムからタグを削除します。 |
| ListTagResources | ListTagResources | タグをクエリします。 |
クォータ
|
API |
タイトル |
説明 |
| SetDirQuota | SetDirQuota | ファイルシステムにディレクトリクォータを作成します。 |
| CancelDirQuota | ファイルシステムのディレクトリクォータをキャンセルします | ファイルシステムのディレクトリクォータをキャンセルします。 |
| DescribeDirQuotas | DescribeDirQuotas | ファイルシステムのディレクトリクォータを照会します。 |
ライフサイクル管理
|
API |
タイトル |
説明 |
| CreateLifecyclePolicy | CreateLifecyclePolicy | ライフサイクルポリシーを作成します。 |
| UpdateLifecyclePolicy | UpdateLifecyclePolicy | ライフサイクルポリシーのルールを更新します。この操作は、CPFS for AI ファイルシステムでのみサポートされています。`UpdateLifecyclePolicy` 操作はポリシー全体を上書きします。オプションのパラメーターを省略すると、対応する構成が削除されます。既存のポリシーにルールを追加するには、`DescribeLifecyclePolicies` 操作を呼び出して現在のポリシーを取得し、新しいルールを追加してから、更新された構成で `UpdateLifecyclePolicy` を呼び出してください。 |
| DeleteLifecyclePolicy | DeleteLifecyclePolicy | ライフサイクルポリシーを削除します。 |
| ModifyLifecyclePolicy | ModifyLifecyclePolicy | ライフサイクルポリシーを変更します。 |
| GetDirectoryOrFileProperties | GetDirectoryOrFileProperties | 指定されたディレクトリに低頻度アクセスファイルまたはアーカイブストレージファイルが含まれているか、または指定されたファイルが低頻度アクセスファイルまたはアーカイブストレージファイルであるかを確認します。 |
| DescribeLifecyclePolicies | ライフサイクル管理ポリシーを照会します | ライフサイクル管理ポリシーのリストを取得します。 |
| CreateLifecycleRetrieveJob | データ取得タスクの作成 | データ取得タスクを作成します。 |
| CancelLifecycleRetrieveJob | CancelLifecycleRetrieveJob | 実行中のデータ取得タスクをキャンセルします。 |
| RetryLifecycleRetrieveJob | RetryLifecycleRetrieveJob | 失敗したデータ取得タスクを再試行します。 |
| StartLifecyclePolicyExecution | StartLifecyclePolicyExecution | ライフサイクルポリシーの実行を開始します。 |
| StopLifecyclePolicyExecution | StopLifecyclePolicyExecution | ライフサイクルポリシーの実行を停止します。 |
| DescribeLifecyclePolicyLogs | DescribeLifecyclePolicyLogs | ライフサイクルポリシーの実行ログを照会します。過去 90 日間のログエントリを最大 1,000 件返します。この機能は CPFS AI Computing Edition でのみ利用可能です。 |
| ListLifecycleRetrieveJobs | ListLifecycleRetrieveJobs | データ取得タスクを照会します。 |
| ListDirectoriesAndFiles | ListDirectoriesAndFiles | 汎用型 NAS ファイルシステムの指定されたディレクトリから、低頻度アクセスファイルとそれらを含むサブディレクトリをリストアップします。 |
ゴミ箱
|
API |
タイトル |
説明 |
| EnableRecycleBin | EnableRecycleBin | ファイルシステムのゴミ箱機能を有効にします。 |
| DisableAndCleanRecycleBin | DisableAndCleanRecycleBin | 汎用型 NAS ファイルシステムのゴミ箱を無効化し、空にします。 |
| UpdateRecycleBinAttribute | UpdateRecycleBinAttribute | ファイルシステムのゴミ箱内のデータの保存期間を変更します。 |
| GetRecycleBinAttribute | GetRecycleBinAttribute | 汎用型 NAS ファイルシステムのゴミ箱の構成を照会します。 |
| CreateRecycleBinRestoreJob | CreateRecycleBinRestoreJob | ゴミ箱からファイルまたはディレクトリを復元します。 |
| CreateRecycleBinDeleteJob | CreateRecycleBinDeleteJob | ゴミ箱からファイルまたはディレクトリを完全に削除するジョブを作成します。 |
| CancelRecycleBinJob | CancelRecycleBinJob | ゴミ箱の実行中のジョブをキャンセルします。 |
| ListRecycleBinJobs | ListRecycleBinJobs | ゴミ箱のジョブを照会します。 |
| ListRecentlyRecycledDirectories | ListRecentlyRecycledDirectories | 最近削除されたディレクトリをクエリします。 |
| ListRecycledDirectoriesAndFiles | ListRecycledDirectoriesAndFiles | 削除されたファイルまたはディレクトリを照会します。 |
SMB AD ACL
|
API |
タイトル |
説明 |
| EnableSmbAcl | EnableSmbAcl | Active Directory (AD) ドメイン内のサーバーメッセージブロック (SMB) ファイルシステムのアクセス制御リスト (ACL) 機能を有効にします。 |
| DisableSmbAcl | DisableSmbAcl | Active Directory (AD) ドメインに存在するサーバーメッセージブロック (SMB) ファイルシステムのアクセス制御リスト (ACL) 機能を無効にします。 |
| ModifySmbAcl | ModifySmbAcl | Active Directory (AD) ドメインに存在するサーバーメッセージブロック (SMB) ファイルシステムのアクセス制御リスト (ACL) 機能に関する情報を更新します。 |
| DescribeSmbAcl | DescribeSmbAcl | Active Directory (AD) ドメイン内のサーバーメッセージブロック (SMB) ファイルシステムのアクセス制御リスト (ACL) 機能に関する情報を照会します。 |
| CreateFile | CreateFile | ディレクトリまたはファイルを作成します。 |
NFS NAS ACL
|
API |
タイトル |
説明 |
| EnableNfsAcl | EnableNfsAcl | ファイルシステムの NFS ACL 機能を有効にします。 |
| DisableNfsAcl | DisableNfsAcl | ファイルシステムの NFS ACL 機能を無効にします。 |
| DescribeNfsAcl | DescribeNfsAcl | ファイルシステムの NFS ACL 機能が有効になっているかどうかを照会します。 |
ログ管理
|
API |
タイトル |
説明 |
| CreateLogAnalysis | CreateLogAnalysis | 汎用型 NAS ファイルシステムのログを Simple Log Service にダンプします。 |
| DeleteLogAnalysis | DeleteLogAnalysis | 汎用型 NAS ファイルシステムのログダンプ機能を無効にします。 |
| DescribeLogAnalysis | ログ分析情報を取得します | ログ分析のログ分析設定をリストします。 |
リソースグループ
|
API |
タイトル |
説明 |
| ChangeResourceGroup | リソースグループを変更します | ファイルシステムインスタンスが属するリソースグループを変更します。 |
仮想ストアチャンネル
|
API |
タイトル |
説明 |
| DetachVscFromFilesystems | VSC デバイスをファイルシステムから関連付け解除します。 | VSC デバイスをファイルシステムから関連付け解除します。 |
| AttachVscToFilesystems | VSC デバイスをファイルシステムに関連付けます | VSC デバイスをファイルシステムに関連付けます。 |
| DescribeFilesystemsVscAttachInfo | ファイルシステムに関連付けられた仮想ストレージチャネル情報を照会します。 | ファイルシステムに関連付けられた仮想ストレージチャネル情報を照会します。 |