Mengkueri Tugas berdasarkan parameter yang ditentukan.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dm:QueryTaskByParam |
get |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| PageNo |
integer |
No |
Nomor halaman. Nilai default: 1. |
1 |
| PageSize |
integer |
No |
Jumlah entri per halaman. Nilai default: 10. |
10 |
| KeyWord |
string |
No |
Kata kunci untuk kueri. Jika dikosongkan, semua Tugas akan dikembalikan. |
mesh-notification-788717 |
| Status |
integer |
No |
Status Tugas. Jika dikosongkan, Tugas dalam semua status akan dikembalikan. |
0 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| PageSize |
integer |
The number of entries per page. |
10 |
| RequestId |
string |
The request ID. |
10A1AD70-E48E-476D-98D9-39BD92193837 |
| PageNumber |
integer |
The page number. |
3 |
| TotalCount |
integer |
The total number of entries. |
15 |
| data |
object |
||
| task |
array<object> |
The returned data. |
|
|
object |
|||
| ReceiversName |
string |
The recipient name. |
TKP000442-333 |
| TagName |
string |
The tag. |
202201 |
| TaskStatus |
string |
The task status. A value of 1 indicates that the email is sent. |
1 |
| CreateTime |
string |
The time when the task was created. |
2022-04-18T10:36Z |
| RequestCount |
string |
The number of requests. |
1 |
| AddressType |
string |
The address type. A value of 1 indicates a sender address. A value of 0 indicates a random address. |
0 |
| UtcCreateTime |
integer |
The time when the task was created, in UTC format. |
1569734892 |
| TemplateName |
string |
The template name. |
Short Simple |
| TaskId |
string |
The task ID. |
1054296 |
| IpPoolId |
string |
The ID of the dedicated IP address pool. |
xxx |
| IpPoolName |
string |
The name of the dedicated IP address pool. |
测试专属IP地址池1 |
| ConfigSetId |
string |
The configuration set ID. |
xxx |
| ConfigSetName |
string |
The configuration set name. |
xxx |
Contoh
Respons sukses
JSONformat
{
"PageSize": 10,
"RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
"PageNumber": 3,
"TotalCount": 15,
"data": {
"task": [
{
"ReceiversName": "TKP000442-333",
"TagName": "202201",
"TaskStatus": "1",
"CreateTime": "2022-04-18T10:36Z",
"RequestCount": "1",
"AddressType": "0",
"UtcCreateTime": 1569734892,
"TemplateName": "Short Simple",
"TaskId": "1054296",
"IpPoolId": "xxx",
"IpPoolName": "测试专属IP地址池1",
"ConfigSetId": "xxx",
"ConfigSetName": "xxx"
}
]
}
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidKeyword.Malformed | The specified keyword is wrongly formed. | |
| 400 | InvalidStatus.Malformed | The specified status is wrongly formed. | |
| 500 | InternalError | The request processing has failed due to some unknown error. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.