调用PutProject接口创建一个项目。目前支持创建文档标准型、图片标准型和视频标准型项目，请根据需要处理的内容类型创建相应项目。

背景信息

建议使用控制台创建项目，以便您了解和确认计费相关信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 PutProject

操作接口名称，系统规定参数，固定取值为PutProject。
Project String 是 immtest

项目名称。

项目名称的长度限制为1~50字符，只能包含英文字母，数字和短横线（-），必须以英文字母开头，且不能为ALL（保留字）。
Type String 是 DocStarter

项目的类型，请根据实际需要选择。包括如下选项：

  • DocStarter：文档标准型，支持文档转换和文档预览功能。
  • PhotoStarter：图片标准型，支持标签检测、人脸检测、二维码检测等功能。
  • VideoStarter：视频标准型，支持视频压缩等功能。
RegionId String 否 cn-hangzhou

项目所在地域的ID。
ServiceRole String 否 AliyunIMMDefaultRole

服务角色，授权给IMM服务以访问其他云资源（例如OSS）的权限，默认值为AliyunIMMDefaultRole。

您也可以通过RAM控制台创建授权角色。具体操作，请参见创建普通服务角色。

CU Integer 否 5

当BillingType设置为ByCU时，才能设置此参数。

每秒能够处理的最大请求数，取值范围为0~10。该值为1表示每秒钟只能处理1个请求，该值为0表示项目不再计费。
BillingType String 否 ByCU

计费类型，包括如下选项：

  • ByCU：按最大CU计费。

  • ByUsage：按实际的API调用次数计费，每小时结算一次。当Type设置为DocStarter（文档标准型）时有效。

    为了控制瞬时提交大量API带来的影响，此计费模式下每次只能提交一个任务，只有等一个任务结束后才能提交另一个任务。

当项目类型不同时计费方式不同。

  • 当Type设置为DocStarter（文档标准型）时，如果不设置此参数，则默认值为ByUsage。
  • 当Type设置为PhotoStarter（图片标准型）或者VideoStarter（视频标准型）时，必须设置此参数为ByCU。
    说明 VideoStarter类型不计算CU费用，而是按照视频时长计费。

关于计费的更多信息，请参见计费说明。

返回数据

名称 类型 示例值 描述
BillingType String ByCU

计费类型，和请求时一致。
CU Integer 5

当BillingType设置为ByCU时，此参数才生效。

每秒能够处理的最大请求数，和请求时一致。
CreateTime String 2020-11-10T03:50:28Z

项目的创建时间。
Endpoint String imm.cn-hangzhou.aliyuncs.com

项目所在地域的服务地址。
ModifyTime String 2020-11-10T03:50:28Z

项目的修改时间。

创建项目后，如果未更新过项目，则项目的修改时间和项目的创建时间相同。
Project String immtest

项目名称，和请求时一致。
RegionId String cn-hangzhou

项目所在地域的ID。
RequestId String 7F7D235C-76FF-4B65-800C-8238AE3F7230

当次请求的Request ID。
ServiceRole String AliyunIMMDefaultRole

服务角色，和请求时一致。

如果创建项目时未指定此参数，则返回值为空。
Type String DocStarter

项目的类型，和请求时一致。

示例

请求示例

http(s)://[Endpoint]/?Action=PutProject
&Project=immtest
&Type=DocStarter
&<公共请求参数>

正常返回示例

XML 格式 

<ModifyTime>2020-11-10T03:50:28Z</ModifyTime>
<Project>immtest</Project>
<Type>DocStarter</Type>
<CU>5</CU>
<ServiceRole>AliyunIMMDefaultRole</ServiceRole>
<Endpoint>imm.cn-hangzhou.aliyuncs.com</Endpoint>
<RequestId>7F7D235C-76FF-4B65-800C-8238AE3F7230</RequestId>
<CreateTime>2020-11-10T03:50:28Z</CreateTime>
<RegionId>cn-hangzhou</RegionId>
<BillingType>ByCU</BillingType>

JSON 格式 

{
    "ModifyTime": "2020-11-10T03:50:28Z",
    "Project": "immtest",
    "Type": "DocStarter",
    "CU": 5,
    "ServiceRole": "AliyunIMMDefaultRole",
    "Endpoint": "imm.cn-hangzhou.aliyuncs.com",
    "RequestId": "7F7D235C-76FF-4B65-800C-8238AE3F7230",
    "CreateTime": "2020-11-10T03:50:28Z",
    "RegionId": "cn-hangzhou",
    "BillingType": "ByCU"
}

错误码

HttpCode

错误码

错误信息

描述

400

InvalidParameter.Project

The input parameter Project is not valid. Only (a ~ z. A ~ Z. 0 ~ 9. -) allowed and start with a letter. less than 50 chars

指定的Project名称无效。

400

InvalidProject.AlreadyExist

The resource Project already exists. Please check.

指定的Project已存在。

400

InvalidProject.Deleting

The resource Project is deleting. Please check.

指定的Project正在删除中，项目会在北京时间次日凌晨删除。删除后，才可以新建同名的项目，如果需要立即创建同名的项目，请提交工单。

400

InvalidParameter.Type

The input parameter Type is not valid. Please refer to document.

Type的类型不合法，请参考Type参数的描述进行设置。

400

InvalidParameter.CU

The input parameter CU is not valid. Please refer to document.

CU值不合法，请参考CU参数的描述进行设置。