Queries the whitelist of the Agent file service.
Operation description
Queries the whitelist of the Agent file service.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| DBInstanceName |
string |
Yes |
The instance ID of the PolarDB-X instance. |
pxc-xxxxxxxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Data |
object |
The response data. |
|
| Groups |
array<object> |
The list of whitelist groups. |
|
|
object |
The whitelist group. |
||
| GroupName |
string |
The name of the whitelist group. |
default |
| IpLists |
string |
The list of IP addresses. |
192.168.1.0/24,10.0.0.1 |
| GroupTag |
string |
The tag of the whitelist group. |
default |
| CustinsName |
string |
The name of the managed instance. |
pxfs-xxxxxxxx |
| 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 identity used for authentication in the request. |
xxx |
| PolicyType |
string |
The policy type. |
PRIORITY |
| NoPermissionType |
string |
The type of the permission denial. |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
The encoded diagnostic message. |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Data": {
"Groups": [
{
"GroupName": "default",
"IpLists": "192.168.1.0/24,10.0.0.1",
"GroupTag": "default"
}
],
"CustinsName": "pxfs-xxxxxxxx"
},
"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.