API 標準および多言語対応の SDK
本製品 (pds/2022-03-01) の API は、ROA 標準に準拠した 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 |
タイトル |
説明 |
| UpdateDomain | UpdateDomain | ドメイン情報を更新します。 |
| ListDomains | ListDomains | ドメインのリストを取得します。 |
| GetDomain | GetDomain | ドメイン情報を取得します。 |
| DeleteDomain | DeleteDomain | ドメインを削除します。 |
| CreateDomain | CreateDomain | ドメインを作成します。 |
| SearchDomains | SearchDomains | ドメインを検索します。 |
認証と権限付与
|
API |
タイトル |
説明 |
| Authorize | Authorize | OAuth 2.0 の認可をリクエストします。 |
アカウント管理
|
API |
タイトル |
説明 |
| GetLinkInfoByUserId | GetLinkInfoByUserId | ユーザー ID に基づいてアカウント情報を取得します。 |
| GetLinkInfo | GetLinkInfo | アカウント情報を取得します。 |
| UnLinkAccount | Unlink Account | 指定されたアイデンティティをユーザーアカウントからリンク解除します。 |
グループ管理
|
API |
タイトル |
説明 |
| UpdateGroup | UpdateGroup | 指定のグループを更新します。 |
| GetGroup | GetGroup | グループに関する情報を取得します。 |
| DeleteGroup | DeleteGroup | グループを削除します。グループを削除する前に、そのグループに他のグループまたはユーザーが含まれていないことを確認してください。含まれている場合、削除に失敗します。 |
| CreateGroup | CreateGroup | グループを作成します。 |
| ListGroup | ListGroup | グループを一覧表示します。 |
| AddGroupMember | AddGroupMember | メンバーをグループに追加します。 |
| RemoveGroupMember | RemoveGroupMember | グループからメンバーを削除します。 |
| ListGroupMember | ListGroupMember | グループメンバーを一覧表示します。 |
ユーザー管理
|
API |
タイトル |
説明 |
| GetUser | GetUser | ユーザー情報を取得します。 |
| CreateUser | CreateUser | ユーザーを作成します。 |
| ImportUser | ImportUser | ユーザーをインポートします。 |
| UpdateUser | UpdateUser | ユーザー情報を変更します。 |
| DeleteUser | DeleteUser | ユーザーを削除します。 |
| ListUser | ListUser | ユーザーを一覧表示します。 |
| SearchUser | SearchUser | ユーザーを検索します。 |
スペース管理
|
API |
タイトル |
説明 |
| DeleteDrive | DeleteDrive | ドライブを削除します。 |
| CreateDrive | CreateDrive | ドライブを作成します。 |
| UpdateDrive | UpdateDrive | ドライブの情報を変更します。 |
| GetDrive | GetDrive | ドライブの情報を返します。 |
| ListDrive | ListDrive | ドライブを一覧表示します。 |
| GetDefaultDrive | GetDefaultDrive | 指定したユーザーのデフォルトドライブを取得します。 |
| ListMyDrives | ListMyDrives | ログイン中のユーザーが所有するドライブの一覧を取得します。 |
| SearchDrive | SearchDrive | ドライブを検索します。 |
ファイル管理
|
API |
タイトル |
説明 |
| ListFile | ListFile | 指定されたフォルダの直下にあるファイルとフォルダを一覧表示します。 |
| CreateFile | CreateFile | ファイルまたはフォルダーを作成します。 |
| DeleteFile | DeleteFile | ファイルまたはフォルダーを削除します。 |
| UpdateFile | UpdateFile | ファイルのメタデータを更新します。この操作では、ファイルコンテンツは変更されません。 |
| SearchFile | SearchFile | ファイルを検索します。 |
| GetFile | GetFile | ファイルの詳細情報を取得します。 |
| DownloadFile | DownloadFile | ファイルをダウンロードします。 |
| GetUploadUrl | GetUploadUrl | アップロードアドレスを取得します。 |
| ListUploadedParts | ListUploadedParts | 特定のマルチパートアップロードでアップロードに成功したパートを一覧表示します。 |
| CompleteFile | CompleteFile | ファイルのアップロードを完了します。 |
| MoveFile | MoveFile | ファイルまたはフォルダを移動します。 |
| CopyFile | CopyFile | ファイルまたはディレクトリをコピーします。 |
| GetDownloadUrl | GetDownloadUrl | ファイルのダウンロード URL を取得します。 |
| FilePutUserTags | FilePutUserTags | ファイルにユーザータグを追加します。 |
| FileDeleteUserTags | FileDeleteUserTags | ファイルからカスタムタグを削除します。 |
| VideoDRMLicense | VideoDRMLicense | ビデオの DRM ライセンスを取得します。 |
ファイルバージョン管理
|
API |
タイトル |
説明 |
| DeleteRevision | DeleteRevision | 過去のリビジョンを削除します。最新のリビジョンは削除できません。 |
| UpdateRevision | UpdateRevision | リビジョンの情報を更新します。リビジョンを永久に保持するように設定したり、説明を追加したりできます。ファイルごとに最大 50 個のリビジョンを永久に保持できます。 |
| RestoreRevision | RestoreRevision | ファイルの過去のリビジョンを復元し、最新のリビジョンにします。この操作では新しいリビジョンが作成されますが、元の過去のリビジョンは変更されません。最新のリビジョンを復元することはできません。 |
| ListRevision | ListRevision | ファイルのリビジョンを一覧表示します。 |
| GetRevision | GetRevision | ファイルリビジョンの詳細を取得します。 |
増分処理
|
API |
タイトル |
説明 |
| ScanFile | ScanFile | ファイルをスキャンします。 |
| ListDelta | ListDelta | デルタの一覧を取得します。 |
| DeltaGetLastCursor | DeltaGetLastCursor | デルタオペレーション用の最新のカーソルを取得します。 |
権限管理
|
API |
タイトル |
説明 |
| ListReceivedFile | ListReceivedFile | 個人用スペースから現在のユーザーに共有されたファイルを一覧表示します。 |
| ListMyGroupDrive | ListMyGroupDrive | 権限のあるグループドライブを一覧表示します。 |
| FileRemovePermission | FileRemovePermission | ファイル共有権限を取り消します。 |
| FileAddPermission | ユーザーまたはグループにファイル共有の権限付与を行います | フォルダレベルの権限付与を行います。各ドライブは最大値 1000 件の権限付与レコードをサポートします。この制限を超える権限付与レコードは効果がありません。 |
| FileListPermission | FileListPermission | ファイルの権限レコードを一覧表示します。 |
| ListAssignment | ListAssignment | ロールの割り当てを一覧表示します。 |
| AssignRole | AssignRole | この操作は、ユーザーにチーム管理者ロールを割り当てます。 |
| CancelAssignRole | CancelAssignRole | 現在、この操作はチーム管理者ロールの取り消しのみに対応しています。 |
共有管理
|
API |
タイトル |
説明 |
| CreateShareLink | CreateShareLink | 共有リンクを作成します。 |
| UpdateShareLink | UpdateShareLink | 共有リンクを更新します。 |
| SearchShareLink | SearchShareLink | 共有を検索します。 |
| CancelShareLink | CancelShareLink | 共有リンクをキャンセルします。 |
| ListShareLink | ListShareLink | 共有を一覧表示します。 |
| GetShareLink | GetShareLink | 共有リンクの情報を取得します。 |
| GetShareLinkByAnonymous | GetShareLinkByAnonymous | 認証なしで共有リンクのメタデータを取得します。 |
| GetShareLinkToken | GetShareLinkToken | 匿名でシェアトークンを取得します。 |
ゴミ箱管理
|
API |
タイトル |
説明 |
| TrashFile | TrashFile | ファイルまたはフォルダをゴミ箱に移動します。 |
| ClearRecyclebin | ClearRecyclebin | ごみ箱内のすべてのファイルとフォルダーを完全削除します。 |
| ListRecyclebin | ListRecyclebin | ごみ箱内のファイルとフォルダーを一覧表示します。 |
| RestoreFile | RestoreFile | ごみ箱からファイルまたはフォルダーを復元します。 |