ListExportZookeeperData API リファレンス - MSE

Microservices Engine (MSE) Zookeeper インスタンスの履歴データのエクスポートタスクを一覧表示します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:ListExportZookeeperData

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンスの ID。	mse-cn-7pp2d1****
PageNumber	integer	任意	返すページ番号。	0
PageSize	integer	任意	各ページに返すエントリ数。	10
AcceptLanguage	string	任意	レスポンスの言語。有効な値： zh：中国語 en：英語	zh

レスポンスフィールド

フィールド	型	説明	例
	object	BaseResult<List>
Success	boolean	リクエストが成功したかどうかを示します。有効な値： `true`：リクエストは成功しました。 `false`：リクエストは失敗しました。	true
Message	string	返されるメッセージ。	The request was successfully processed.
DynamicMessage	string	エラーメッセージの動的な部分。このパラメーターは、ErrMessage パラメーターの %s 変数を置き換えるために使用されます。説明 ErrMessage パラメーターの戻り値が The Value of Input Parameter %s is not valid で、DynamicMessage パラメーターの戻り値が DtsJobId の場合、指定された DtsJobId パラメーターは無効であることを示します。	The specified parameter is invalid.
RequestId	string	リクエストの ID。	8BD1E58D-0755-42AC-A599-E6B55112****
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	mse-100-000
HttpStatusCode	string	返される HTTP ステータスコード。	200
Data	array<object>	データの詳細。
	object	データ構造。
InstanceId	string	インスタンスの ID	mse-cn-st21ri2****
ExportType	string	エクスポートされるオブジェクトのタイプ。有効な値： transactionLog：トランザクションログ snapshot：スナップショット	snapshot
ContentMap	string	タスクの詳細。	{}
Extend	string	JSON 形式の拡張情報。この情報により、パラメーターの追加が容易になります。	{}
Status	string	タスクのステータス。有効な値： CREATE：タスクは作成中です。 RUNNING：タスクは実行中です。 FINISH：タスクは完了しました。 FAILED：タスクは失敗しました。 EXPIRE：タスクは期限切れです。	FINISH
KubeoneTaskIds	string	基盤レイヤーで関連付けられたタスクの ID。このパラメーターは、障害のトラブルシューティングにのみ使用されます。	10
Id	integer	タスクの ID。	1
CreateTime	integer	タスクが作成された時間。	1631001140913
UpdateTime	integer	タスクが更新された時間。	1632979237663

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Message": "The request was successfully processed.\n",
  "DynamicMessage": "The specified parameter is invalid.",
  "RequestId": "8BD1E58D-0755-42AC-A599-E6B55112****",
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": "200",
  "Data": [
    {
      "InstanceId": "mse-cn-st21ri2****",
      "ExportType": "snapshot",
      "ContentMap": "{}",
      "Extend": "{}",
      "Status": "FINISH",
      "KubeoneTaskIds": "10",
      "Id": 1,
      "CreateTime": 1631001140913,
      "UpdateTime": 1632979237663
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

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

変更履歴

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