Queries the information about an Agent file service instance.
Operation description
Queries the information about an Agent file service instance.
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 PolarDB-X instance ID. |
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. |
|
| Instance |
object |
The instance information. |
|
| InstanceId |
string |
The associated instance ID. |
pxc-xxxxxxxx |
| DBInstanceName |
string |
The PolarDB-X instance ID. |
pxc-xxxxxxxx |
| PxfsInstanceId |
string |
The Agent file service instance ID. |
pxfs-xxxxxxxx |
| RegionId |
string |
The region ID. |
cn-hangzhou |
| ZoneId |
string |
The zone ID. |
cn-hangzhou-h |
| ClassCode |
string |
The node specification. |
polarx.pxfs.x4.xlarge |
| NodeCount |
integer |
The number of nodes. |
3 |
| StorageSize |
integer |
The storage size. |
500 |
| CreateTime |
string |
The creation time. |
2026-09-03T12:00:00Z |
| Status |
string |
The status. |
ACTIVE |
| StorageType |
string |
The storage type. |
cloud_essd |
| VPCId |
string |
The virtual private cloud (VPC) ID. |
vpc-xxxxxxxx |
| VSwitchId |
string |
The vSwitch ID. |
vsw-xxxxxxxx |
| Version |
string |
The current version. |
1.0.0 |
| ConnAddrs |
array<object> |
The list of connection addresses. |
|
|
object |
The connection address. |
||
| Type |
string |
The connection type. |
Intranet |
| Endpoint |
string |
The endpoint. |
agent-files.example.com |
| ConnectionString |
string |
The connection string. |
agent-files.example.com:12049 |
| Port |
integer |
The port number. |
12049 |
| Protocol |
string |
The access protocol. |
NFS |
| Transport |
string |
The transport protocol. |
TLS |
| TlsEnabled |
boolean |
Indicates whether TLS is enabled. |
true |
| VPCId |
string |
The virtual private cloud (VPC) ID. |
vpc-xxxxxxxx |
| VSwitchId |
string |
The vSwitch ID. |
vsw-xxxxxxxx |
| AccessDeniedDetail |
object |
The details about the access denial. |
|
| AuthAction |
string |
The authorization action. Same as described above. |
xxx |
| AuthPrincipalType |
string |
The authorization action. Same as described above. |
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 |
The type of missing permission. |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
The encoded diagnostic message. |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Data": {
"Instance": {
"InstanceId": "pxc-xxxxxxxx",
"DBInstanceName": "pxc-xxxxxxxx",
"PxfsInstanceId": "pxfs-xxxxxxxx",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-h",
"ClassCode": "polarx.pxfs.x4.xlarge",
"NodeCount": 3,
"StorageSize": 500,
"CreateTime": "2026-09-03T12:00:00Z",
"Status": "ACTIVE",
"StorageType": "cloud_essd",
"VPCId": "vpc-xxxxxxxx",
"VSwitchId": "vsw-xxxxxxxx",
"Version": "1.0.0",
"ConnAddrs": [
{
"Type": "Intranet",
"Endpoint": "agent-files.example.com",
"ConnectionString": "agent-files.example.com:12049",
"Port": 12049,
"Protocol": "NFS",
"Transport": "TLS",
"TlsEnabled": true,
"VPCId": "vpc-xxxxxxxx",
"VSwitchId": "vsw-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.