SaveFavorites API でのお気に入りにワーク追加 - Quick BI

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:SaveFavorites

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	必須	作業をお気に入りに追加するユーザーの ID。このユーザー ID は Quick BI の UserID であり、Alibaba Cloud の UID ではありません。	121344444790****
WorksId	string	必須	お気に入りに追加する作業の ID。	d23e84a1-82a0-4292-bfdb-521306c3****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	boolean	インターフェイスの実行結果を返します。有効な値： true：実行に成功しました false：実行に失敗しました	true
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストに成功しました false：リクエストに失敗しました	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": true,
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.
400	Workspace.Not.Exist	The group workspace does not exist.
400	Workspace.Status.Error	This group workspace has been disabled or deleted.

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

変更履歴

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