RenameWorkflowDefinition API で DataStudio ワークフローを名前変更 - DataWorks

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID です。DataWorks コンソール（https://workbench.data.aliyun.com/console）にログインし、[ワークスペース] ページで確認できます。このパラメーターは必須であり、API オペレーションが適用される DataWorks ワークスペースを指定するために設定する必要があります。	10000
Id	string	必須	Data Studio ワークフローの一意の識別子です。説明 SDK バージョン 8.0.0 より前では Long 型、SDK バージョン 8.0.0 以降では String 型です。この型の変更は、SDK の通常使用には影響しません。パラメーターは SDK で定義された型に従って返されます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ、コンパイルエラーが発生する可能性があります。その場合は、データ型を手動で更新する必要があります。	463497880880954****
Name	string	必須	ワークフローの一意の識別子です。説明 SDK バージョン 8.0.0 より前では Long 型、SDK バージョン 8.0.0 以降では String 型です。この型の変更は、SDK の通常使用には影響しません。パラメーターは SDK で定義された型に従って返されます。ただし、SDK をバージョン 8.0.0 をまたいでアップグレードする場合にのみ、コンパイルエラーが発生する可能性があります。その場合は、データ型を手動で更新する必要があります。	Rename

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
RequestId	string	リクエスト ID です。トラブルシューティング時に問題の特定に使用できます。	975BD43D-C421-595C-A29C-565A8AD5XXXX
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true false	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "975BD43D-C421-595C-A29C-565A8AD5XXXX",
  "Success": true
}

エラーコード

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

変更履歴

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