查询Agent文件服务实例信息
接口说明
查询 Agent 文件服务实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-hangzhou |
| DBInstanceName |
string |
是 |
PolarDB-X 实例 ID |
pxc-xxxxxxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数 |
||
| RequestId |
string |
请求 ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Data |
object |
返回数据 |
|
| Instance |
object |
实例信息 |
|
| InstanceId |
string |
关联实例 ID |
pxc-xxxxxxxx |
| DBInstanceName |
string |
PolarDB-X 实例 ID |
pxc-xxxxxxxx |
| PxfsInstanceId |
string |
Agent 文件服务实例 ID |
pxfs-xxxxxxxx |
| RegionId |
string |
地域 ID |
cn-hangzhou |
| ZoneId |
string |
可用区 ID |
cn-hangzhou-h |
| ClassCode |
string |
节点规格 |
polarx.pxfs.x4.xlarge |
| NodeCount |
integer |
节点数量 |
3 |
| StorageSize |
integer |
存储空间 |
500 |
| CreateTime |
string |
创建时间 |
2026-09-03T12:00:00Z |
| Status |
string |
状态 |
ACTIVE |
| StorageType |
string |
存储类型 |
cloud_essd |
| VPCId |
string |
专有网络 ID |
vpc-xxxxxxxx |
| VSwitchId |
string |
交换机 ID |
vsw-xxxxxxxx |
| Version |
string |
当前版本 |
1.0.0 |
| ConnAddrs |
array<object> |
连接地址列表 |
|
|
object |
连接地址 |
||
| Type |
string |
连接类型 |
Intranet |
| Endpoint |
string |
访问地址 |
agent-files.example.com |
| ConnectionString |
string |
连接字符串 |
agent-files.example.com:12049 |
| Port |
integer |
端口 |
12049 |
| Protocol |
string |
访问协议 |
NFS |
| Transport |
string |
传输协议 |
TLS |
| TlsEnabled |
boolean |
是否启用 TLS |
true |
| VPCId |
string |
专有网络 ID |
vpc-xxxxxxxx |
| VSwitchId |
string |
交换机 ID |
vsw-xxxxxxxx |
| AccessDeniedDetail |
object |
无权限访问详情 |
|
| AuthAction |
string |
说明如上。 |
xxx |
| AuthPrincipalType |
string |
说明如上。 |
222 |
| AuthPrincipalOwnerId |
string |
鉴权主体 OwnerId |
111 |
| AuthPrincipalDisplayName |
string |
鉴权主体名称 |
xxx |
| PolicyType |
string |
策略类型 |
PRIORITY |
| NoPermissionType |
string |
无权限类型 |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
诊断信息 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
示例
正常返回示例
JSON格式
{
"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=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。