DescribeAgenticDBProjects - 查询 AgenticDB 项目列表

更新时间:
复制 MD 格式

查询 AgenticDB 项目列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeAgenticDBProjects

get

*DBCluster

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

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID

cn-hangzhou

DBClusterId

string

是

AgenticDB 集群 ID

pagc-bp1abcdef1234567

TenantId

string

否

归属 Tenant ID

t-4b83e0da66674951

ProjectId

string

否

精确匹配 Project ID

proj-a1b2c3d4e5f6

ProjectName

string

否

名称模糊匹配

analytics

PageSize

integer

否

每页记录数,默认 30,最大 100

30

PageNumber

integer

否

页码,默认 1

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID

F6A7B8C9-D0E1-2345-FABC-456789012345

TotalCount

integer

总数

1

PageNumber

integer

当前页码

1

PageSize

integer

每页记录数

30

Items

array<object>

Project 列表

object

Project 信息

TenantId

string

归属 Tenant ID

t-4b83e0da66674951

ProjectId

string

Project ID

proj-a1b2c3d4e5f6

ProjectName

string

Project 名称

analytics-prod

Description

string

备注

Production analytics database

DefaultBranchName

string

默认分支名

main

DefaultBranchId

string

默认分支 ID

br-1a2b3c4d5e6f

DBClusterId

string

关联的 AgenticDB 集群 ID

pagc-bp1abcdef1234567

CreateTime

string

创建时间

时间采用 ISO 8601 格式,时区为 UTC(格式:YYYY-MM-DDTHH:mm:ssZ)。

2026-06-10T11:00:00Z

Status

string

项目状态。取值范围:Active(正常)、Destroying(销毁中)、Destroyed(已销毁)

Active

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。