全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeAITaskStatus - 获取AI任务状态数据

更新时间:Oct 29, 2024

查看PolarDB for AI功能状态。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeAITaskStatusget
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
DBClusterIdstring

集群 ID。

pc-xxxxxxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

DBClusterIdstring

集群 ID。

pc-xxxxxxxxxx
RequestIdstring

请求 ID。

9B7BFB11-C077-4FE3-B051-F69CEB******
Statusstring

PolarDB for AI 功能状态。取值:

  • 1:开启

  • 2:关闭

1
StatusNamestring

PolarDB for AI 功能状态描述。

关闭状态
AccountNamestring

用户上一次设置的访问账号名

示例

正常返回示例

JSON格式

{
  "DBClusterId": "pc-xxxxxxxxxx",
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "Status": "1",
  "StatusName": "关闭状态",
  "AccountName": ""
}

错误码

HTTP status code错误码错误信息描述
400CallDB4AI.ErrorCall db4ai api error.调用db4ai api错误
404InvalidDBInstance.NotFoundThe DBClusterId provided does not exist in our records.我们的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更查看变更详情
2022-08-01新增 OpenAPI查看变更详情