Queries the list of notification recipients for a project.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
No |
The instance ID of the bastion host. Note
You can invoke DescribeInstances to obtain this parameter. |
bastionhost-cn-zvp282aly06 |
| RegionId |
string |
No |
The region ID of the bastion host. Note
For the mapping between region IDs and region names, see Regions and zones. |
cn-hangzhou |
| ProjectId |
integer |
Yes |
The project ID. Note
You can call ListProjects to obtain this parameter. |
3 |
| MaxResults |
integer |
No |
The number of entries to query. Default value: 20. Maximum value: 100. |
20 |
| NextToken |
string |
No |
The request token. Leave this parameter empty or set it to an empty string for the first request. |
4ieSWJCwxvW3dk3wF.BqkrZmP72nWu5zJ5NWydMqyEs**** |
| Keyword |
string |
No |
The name, phone number, or email address of the notification recipient to query. Fuzzy match is supported. |
test |
| Skip |
integer |
No |
The number of entries to skip. Note
This parameter takes effect only when NextToken is empty. |
0 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| TotalCount |
integer |
The total number of recipients returned. |
2 |
| NextToken |
string |
The token for the next request. Use this value for the NextToken request parameter in the next paged query. If this field is empty in the response, no more data is available. This parameter is used for paging. |
4ieSWJCwxvW3dk3wF.BqkrZmP72nWu5zJ5NWydMqyEs**** |
| MaxResults |
integer |
The value of the MaxResults request parameter passed in the request if a valid parameter value was specified. Otherwise, the default value is returned. |
20 |
| Items |
array<object> |
The list of recipients. |
|
|
object |
The list of recipients. |
||
| ReceiverId |
string |
The ID of the notification recipient. |
1 |
| Name |
string |
The name of the recipient. |
name |
| Phone |
string |
The phone number of the recipient. |
131****6412 |
|
string |
The email address of the recipient. |
6291****@qq.com |
|
| RequestId |
string |
The unique request ID. |
81500666-d7f5-4143-8329-0223cc738105 |
Examples
Success response
JSON format
{
"TotalCount": 2,
"NextToken": "4ieSWJCwxvW3dk3wF.BqkrZmP72nWu5zJ5NWydMqyEs****",
"MaxResults": 20,
"Items": [
{
"ReceiverId": "1",
"Name": "name",
"Phone": "131****6412",
"Email": "6291****@qq.com"
}
],
"RequestId": "81500666-d7f5-4143-8329-0223cc738105"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.