ModifyApiDatasourceParameters による API データソースパラメータの変更 - Quick BI

操作説明

クエリ文を変更する場合、最上位の JsonObject のみ変更できます。複数階層にネストされたパラメーターは変更できません。パラメーターの詳細については、「API データソースの作成」をご参照ください。

今すぐお試しください

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

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApiId	string	必須	API データソースの ID。	b66a66de51f24d149116c17718138194
WorkspaceId	string	必須	ワークスペースの ID。	726bee5a-****-43e1-9a8e-b550f0120f35
Parameters	string	必須	API データパラメーターの構成を JSONArray フォーマットで指定します。最大 10 個のパラメーターを変更できます。 name：共通パラメーターまたはクエリ文内のパラメーターの名前。 value：共通パラメーターまたはクエリ文内のパラメーターの値。	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]

レスポンスフィールド

フィールド	型	説明	例
	object	返された情報。
RequestId	string	リクエスト ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	boolean	インターフェイスの実行結果。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": true,
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ApiDataSource.NotIn.Workspace	Target apiId not in target workspace.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	指定されたワークスペースは組織単位内にありません。
400	ApiDatasource.Not.Exist	Api datasource not exist.
400	ApiDatasource.Param.IsNull	Api datasource modify parameters is null.
400	ApiDatasource.Param.Oversize	The number of parameters of API data source exceeds the limit and cannot exceed %s.

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

変更履歴

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