すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:ModifyTaskInfo

最終更新日:Dec 18, 2025

ApsaraDB for MongoDB インスタンスのタスクセンターでタスクの情報を変更します。

操作説明

この操作でタスクに対して実行されるアクションは、タスクの現在の状態によって異なります。タスクでサポートされているアクションは、DescribeHistoryTasks 操作の actionInfo パラメーターの値から取得できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:ModifyTaskInfo

update

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

インスタンスのリージョン ID。 DescribeRegions 操作を呼び出して、リージョン ID を照会できます。

cn-hangzhou

TaskId

string

必須

タスク ID。 複数の ID をコンマ (,) で区切ります。 最大 10 個のタスク ID を指定できます。

t-83br18hlpdrw3uxxxx

StepName

string

必須

ユーザーに表示されるステップ名。

exec_task

TaskAction

string

必須

DescribeHistoryTasks 操作の actionInfo パラメーターで記述された状態に対応するアクション名。

modifySwitchTime

ActionParams

string

任意

アクション関連のパラメーター。 このパラメーターは、ビジネス要件に基づいて拡張できます。 このパラメーターの値は、TaskAction パラメーターの値によって異なります。

{\"recoverMode\":\"immediate\"}

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。

6163731A-XXXX-XXXX-B934-3388DE70C217

ErrorTaskId

string

失敗したタスクの ID。 このパラメーターは、タスクが失敗した場合に返されます。

""

SuccessCount

string

成功したタスクの数。

1

ErrorCode

string

失敗したタスクのエラーコード。 ModifyTaskInfo 操作のエラーコードと同じです。

""

成功レスポンス

JSONJSON

{
  "RequestId": "6163731A-XXXX-XXXX-B934-3388DE70C217",
  "ErrorTaskId": "\"\"",
  "SuccessCount": "1",
  "ErrorCode": "\"\""
}

エラーコード

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

変更履歴

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