DeleteCollectionData_云原生数据仓库 AnalyticDB PostgreSQL版_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为3000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
gpdb:DeleteCollectionData
Create
Collection
acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。展开详情

示例值:gp-xxxxxxxxx参考取值来源:
    UpgradeDBInstance
    CreateDBInstance
    UpdateDBInstancePlan
    DescribeDBInstances
    PauseInstance
    ModifyDBInstancePayType
    ResumeInstance
    UploadDocumentAsync
    DownloadDiagnosisRecords
    UnloadSampleData
Namespacestring

命名空间,默认为 public。展开详情

示例值:mynamespace参考取值来源:
    ListNamespaces
    CreateNamespace
Collectionstring

集合名。展开详情

示例值:document参考取值来源:
    ListCollections
    CreateCollection
    UpsertCollectionData
RegionIdstring

地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
NamespacePasswordstring

命名空间对应的密码。

示例值:testpassword
CollectionDatastring

要删除的数据字段和值。为字典格式的 JSON 字符串,其中 key 为字段名,value 为要删除的数据值列表。

示例值:{"title":["a","b"]}
CollectionDataFilterstring

要删除的数据过滤条件。格式为 SQL WHERE 语法。

示例值:a < 10
WorkspaceIdstring

多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空,当和 DBInstanceId 同时指定时以此参数为准。

示例值:gp-ws-*****

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

返回信息。

示例值:Successful
Statusstring

API 执行状态,取值如下:展开详情

示例值:success
AppliedRowsinteger<int64>

生效的条目。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:10

返回示例

变更历史

变更时间变更内容概要操作
2024-08-04
变更请求参数DBInstanceId
新增请求参数WorkspaceId
2023-11-07
变更请求参数RegionId
变更请求参数NamespacePassword
2023-07-20
新增请求参数CollectionDataFilter

相关示例

删除向量数据
2023-08-01