DescribePxfsUsers - PolarDB - Alibaba Cloud Documentation Center

Queries the tenant identity of the Agent file service.

Operation description

Queries the tenant identity of the Agent file service.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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
TenantId	string	Yes	The tenant ID.	tenant-001

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
Users	array<object>	The list of tenant identities.
	object	The tenant identity.
Role	string	The identity role.	MEMBER
PosixUid	integer	POSIX UID	1000
PosixGid	integer	POSIX GID	1000
Status	string	The status.	ACTIVE
CreateTime	string	The creation time.	2026-09-03T12:00:00Z
IdentityName	string	The identity name.	agent-runtime
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 display name of the authentication principal.	xxx
PolicyType	string	The policy type.	System
NoPermissionType	string	NoPermissionType	ImplicitDeny
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "TenantId": "tenant-001",
    "Users": [
      {
        "Role": "MEMBER",
        "PosixUid": 1000,
        "PosixGid": 1000,
        "Status": "ACTIVE",
        "CreateTime": "2026-09-03T12:00:00Z",
        "IdentityName": "agent-runtime"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "System",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.