签发Agent文件服务访问Token
接口说明
签发 Agent 文件服务访问 Token。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID |
cn-hangzhou |
| DBInstanceName |
string |
是 |
PolarDB-X 实例 ID |
pxc-xxxxxxxx |
| TenantId |
string |
是 |
租户 ID |
tenant-001 |
| IdentityName |
string |
是 |
身份名称 |
agent-runtime |
| TtlSeconds |
integer |
否 |
Token 有效期 |
86400 |
| Label |
string |
否 |
Token 标签 |
production-agent |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数 |
||
| RequestId |
string |
请求 ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Data |
object |
返回数据 |
|
| TenantId |
string |
租户 ID |
tenant-001 |
| TokenId |
string |
Token ID |
token-001 |
| Token |
string |
Token 明文 |
pxfs_tenant-001.token-001.****** |
| Label |
string |
Token 标签 |
production-agent |
| ExpiresAt |
string |
过期时间 |
2026-12-31T23:59:59Z |
| Endpoint |
string |
访问地址 |
agent-files.example.com |
| Port |
integer |
端口 |
12049 |
| IdentityName |
string |
身份名称 |
agent-runtime |
| AccessDeniedDetail |
object |
无权限访问详情 |
|
| AuthAction |
string |
鉴权动作 |
polardbx:QueryColumnarLog |
| 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": {
"TenantId": "tenant-001",
"TokenId": "token-001",
"Token": "pxfs_tenant-001.token-001.******",
"Label": "production-agent",
"ExpiresAt": "2026-12-31T23:59:59Z",
"Endpoint": "agent-files.example.com",
"Port": 12049,
"IdentityName": "agent-runtime"
},
"AccessDeniedDetail": {
"AuthAction": "polardbx:QueryColumnarLog",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。