Creates a whitelist group for PolarDB-X Search.
Operation description
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The ID of the region in which the instance resides. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs. |
cn-hangzhou |
| DBInstanceName |
string |
Yes |
The name of the instance. |
pxc-hzravgpt8q**** |
| GroupName |
string |
Yes |
The name of the whitelist group. |
default |
| IPs |
string |
Yes |
The list of allowed source IP addresses. |
192.168.1.0/24 |
| Remark |
string |
No |
The description of the group ID. |
MAIN |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
6352AC16-76BF-5135-B1EA-ED49293526E6 |
| Data |
object |
The returned result. |
|
| GroupId |
string |
The group ID, which is a globally unique identifier generated by the system for the group. |
237509538 |
| GroupName |
string |
The name of the whitelist group. |
special |
| AccessDeniedDetail |
object |
The details of the access denial. |
|
| AuthAction |
string |
The authentication action. |
xxx |
| AuthPrincipalType |
string |
The type of the authentication principal. |
222 |
| AuthPrincipalOwnerId |
string |
The owner ID of the authentication principal. |
111 |
| AuthPrincipalDisplayName |
string |
The display name of the authentication principal. |
xxx |
| PolicyType |
string |
The policy type. |
PRIORITY |
| NoPermissionType |
string |
NoPermissionType |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
The diagnostic information. |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
Examples
Success response
JSON format
{
"RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
"Data": {
"GroupId": "237509538",
"GroupName": "special"
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.