追跡タスクのリストを取得します。注：呼び出し元の AccessKey (AK) に他のユーザーの追跡タスクを閲覧する権限がない場合、この操作は呼び出し元がアクセスを許可されているタスクのみを返します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PageNum |
integer |
任意 |
ページ番号。
|
1 |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。
|
10 |
| UserNick |
string |
任意 |
追跡タスクを所有するユーザーのニックネーム。このパラメーターが指定されていない場合、すべてのタスクが返されます。 |
test |
| Paused |
boolean |
任意 |
追跡タスクが一時停止されているかどうかを指定します。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエスト ID。 |
0c52************8e1952a3 |
| Result |
object |
追跡タスクのページング情報。 |
|
| PageNum |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
リクエストで設定されたページあたりのエントリ数。 |
10 |
| TotalNum |
integer |
エントリの合計数。 |
1 |
| TotalPages |
integer |
ページの合計数。 |
1 |
| Pre |
integer |
前のページ番号。null または 0 の値は、前のページがないことを示します。 |
null |
| Next |
integer |
次のページ番号。null または 0 の値は、次のページがないことを示します。 |
null |
| Data |
array<object> |
追跡タスクモデルの配列。 |
|
|
object |
追跡タスクモデル。 |
||
| MailId |
string |
追跡タスクのメール ID。 |
2342526 |
| Paused |
boolean |
タスクが一時停止されているかどうかを示します。
|
true |
| BizOwnerUserId |
string |
オーナーのユーザー ID。 |
asag****2423 |
| BizOwnerName |
string |
オーナーのニックネーム。 |
test |
| SubscribeName |
string |
追跡タスクの名前。 |
test |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値：
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "0c52************8e1952a3",
"Result": {
"PageNum": 1,
"PageSize": 10,
"TotalNum": 1,
"TotalPages": 1,
"Pre": 0,
"Next": 0,
"Data": [
{
"MailId": "2342526",
"Paused": true,
"BizOwnerUserId": "asag****2423",
"BizOwnerName": "test",
"SubscribeName": "test"
}
]
},
"Success": true
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | |
| 400 | UserRoleConfig.NotContain.Function | The user %s does not have permission to operate. | |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。