Issues an access token for the Agent file service.
Operation description
Issues an access token for 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 PolarDB-X instance ID. |
pxc-xxxxxxxx |
| TenantId |
string |
Yes |
The tenant ID. |
tenant-001 |
| IdentityName |
string |
Yes |
The identity name. |
agent-runtime |
| TtlSeconds |
integer |
No |
The validity period of the token, in seconds. |
86400 |
| Label |
string |
No |
The token label. |
production-agent |
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. |
|
| TenantId |
string |
The tenant ID. |
tenant-001 |
| TokenId |
string |
Token ID |
token-001 |
| Token |
string |
The token in plaintext. |
pxfs_tenant-001.token-001.****** |
| Label |
string |
The token label. |
production-agent |
| ExpiresAt |
string |
The expiration time of the token. |
2026-12-31T23:59:59Z |
| Endpoint |
string |
The access endpoint. |
agent-files.example.com |
| Port |
integer |
The port number. |
12049 |
| IdentityName |
string |
The identity name. |
agent-runtime |
| AccessDeniedDetail |
object |
The details of the access denial. |
|
| AuthAction |
string |
The authorization action. |
polardbx:QueryColumnarLog |
| AuthPrincipalType |
string |
The type of the authorization principal. |
222 |
| AuthPrincipalOwnerId |
string |
The owner ID of the authorization principal. |
111 |
| AuthPrincipalDisplayName |
string |
The display name of the authorization principal. |
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": {
"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=="
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.