DescribeAgenticDBTenantApiKeys

Queries the list of API keys for an AgenticDB tenant.

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 syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes		cn-hangzhou
DBClusterId	string	Yes		pagc-bp1abcdef1234567
TenantName	string	No		my-saas-app
PageSize	integer	No		30
PageNumber	integer	No		1

Response elements

Element	Type	Description	Example
	object
RequestId	string		C3D4E5F6-A7B8-9012-CDEF-123456789012
TotalCount	integer		2
PageNumber	integer		1
PageSize	integer		30
Items	array<object>
	object
ApiKeyId	string		ak-71304e39c7e841a1
ApiKeyMasked	string		pagc_key_cGFnYy1icDFhMmIz****
TenantId	string		t-4b83e0da66674951
TenantName	string		my-saas-app
Description	string		MCP server token
Status	string		Active
CreateTime	string		2026-06-10T10:30:00Z
ExpireTime	string		2027-01-01T00:00:00Z

Examples

Success response

JSON format

{
  "RequestId": "C3D4E5F6-A7B8-9012-CDEF-123456789012",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 30,
  "Items": [
    {
      "ApiKeyId": "ak-71304e39c7e841a1",
      "ApiKeyMasked": "pagc_key_cGFnYy1icDFhMmIz****",
      "TenantId": "t-4b83e0da66674951",
      "TenantName": "my-saas-app",
      "Description": "MCP server token",
      "Status": "Active",
      "CreateTime": "2026-06-10T10:30:00Z",
      "ExpireTime": "2027-01-01T00:00:00Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.