UpdateProject - 更新项目

更新一个已创建项目(Project)的信息。

接口说明

  • 更新项目信息时,确保项目已经创建成功,创建项目请参考请求参数描述。
  • 更新项目信息时,只需填充需要更新的字段,未填充的字段不会变更。
  • 项目更新成功不会立即生效,需要等待至多 5 分钟的时间。

调试

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

授权信息

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

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

请求参数

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

项目名称,获取方式请参见创建项目

test-project
ServiceRolestring

服务角色,授权给 IMM 服务以访问其他云资源(例如 OSS)的权限。

如果要自定义服务角色,您可以通过 RAM 控制台创建普通服务角色并为角色授权。具体操作,请分别参见创建普通服务角色为角色授权

AliyunIMMDefaultRole
Descriptionstring

项目描述信息。长度为 1~256 个英文或中文字符。

immtest
TemplateIdstring

工作流模板 ID。更多信息,请参见工作流模板与算子

AliyunIMMDefaultRole
ProjectMaxDatasetCountlong

项目中数据集的最大个数。取值范围为 1~1000000000。

1000000000
DatasetMaxBindCountlong

每个数据集绑定的最大个数。取值范围为 1~10。

10
DatasetMaxFileCountlong

每个数据集中文件的最大个数。取值范围为 1~100000000。

100000000
DatasetMaxEntityCountlong

每个数据集中元数据实体的最大个数。

说明 预留参数,使用中并不做实际限制。
10000000000
DatasetMaxRelationCountlong

每个数据集中元数据关系的最大个数。

说明 预留参数,使用中并不做实际限制。
100000000000
DatasetMaxTotalFileSizelong

每个数据集中文件总大小的最大值,超过限制后无法再添加索引。单位为字节。

90000000000000000
Tagarray<object>

标签列表

object

标签信息

Keystring

标签键

TestKey
Valuestring

标签值

TestValue

返回参数

名称类型描述示例值
object

响应结构体

RequestIdstring

请求 ID。

D33C3574-4093-448E-86E7-15BE2BD3****
ProjectProject

项目信息。详细内容请单击 Project 查看。

示例

正常返回示例

JSON格式

{
  "RequestId": "D33C3574-4093-448E-86E7-15BE2BD3****",
  "Project": {
    "ProjectName": "immtest",
    "ServiceRole": "AliyunIMMDefaultRole",
    "TemplateId": "Official:AllFunction",
    "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
    "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
    "Description": "测试项目",
    "ProjectQueriesPerSecond": 100,
    "EngineConcurrency": 100,
    "ProjectMaxDatasetCount": 1000000000,
    "DatasetMaxBindCount": 10,
    "DatasetMaxFileCount": 100000000,
    "DatasetMaxEntityCount": 10000000000,
    "DatasetMaxRelationCount": 100000000000,
    "DatasetMaxTotalFileSize": 90000000000000000,
    "DatasetCount": 5,
    "FileCount": 10,
    "TotalFileSize": 100000,
    "Tags": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-23OpenAPI 入参发生变更查看变更详情
2024-02-28OpenAPI 错误码发生变更查看变更详情
2021-06-15新增 OpenAPI查看变更详情