DescribeAgenticDBProjects-阿里云帮助中心

Queries a list of AgenticDB projects.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeAgenticDBProjects

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBClusterId	string	Yes	The AgenticDB cluster ID.	pagc-bp1abcdef1234567
TenantId	string	No	The tenant ID.	t-4b83e0da66674951
ProjectId	string	No	The project ID used for exact matching.	proj-a1b2c3d4e5f6
ProjectName	string	No	The project name used for fuzzy matching.	analytics
PageSize	integer	No	The number of entries per page. Default value: 30. Maximum value: 100.	30
PageNumber	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
Items	array<object>	The list of projects.
	object	The project information.
CreateTime	string	The creation time. The time is in ISO 8601 format and the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ).	2026-06-10T11:00:00Z
DBClusterId	string	The ID of the associated AgenticDB cluster.	pagc-bp1abcdef1234567
DefaultBranchId	string	The ID of the default branch.	br-1a2b3c4d5e6f
DefaultBranchName	string	The name of the default branch.	main
Description	string	The description.	Production analytics database
HistoryRetentionSeconds	integer	The retention period for recent records of the project. This field may be empty for older projects. To query the current effective value, call DescribeAgenticDBProjectHistoryRetention.	604800
ProjectId	string	Project ID	proj-a1b2c3d4e5f6
ProjectName	string	The name of the project.	analytics-prod
Status	string	The project status. Valid values: Active: Normal. Destroying: Being destroyed. Destroyed: Destroyed.	Active
TenantId	string	The tenant ID.	t-4b83e0da66674951
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page.	30
RequestId	string	The request ID.	F6A7B8C9-D0E1-2345-FABC-456789012345
TotalCount	integer	The total number of entries.	1

Examples

Success response

JSON format

{
  "Items": [
    {
      "CreateTime": "2026-06-10T11:00:00Z",
      "DBClusterId": "pagc-bp1abcdef1234567",
      "DefaultBranchId": "br-1a2b3c4d5e6f",
      "DefaultBranchName": "main",
      "Description": "Production analytics database",
      "HistoryRetentionSeconds": 604800,
      "ProjectId": "proj-a1b2c3d4e5f6",
      "ProjectName": "analytics-prod",
      "Status": "Active",
      "TenantId": "t-4b83e0da66674951"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "F6A7B8C9-D0E1-2345-FABC-456789012345",
  "TotalCount": 1
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.