修改项目基础信息

最近更新时间:2025-08-05 02:50:16

我的收藏

1. 接口描述

接口请求域名: wedata.tencentcloudapi.com 。

修改项目基础信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyProject。
Version String 公共参数,本接口取值:2021-08-20。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 目标修改的项目ID
示例值:"1426"
DisplayName String 项目显示名称,可以为中文名,需要租户范围内唯一
示例值:testpj
Description String 备注
示例值:备注test
TaskSubmitApproval Boolean true/false则修改,不带该参数不修改。
示例值:true
ResourcePoolInfo ResourcePoolInfo 资源池信息
ProjectManagers.N Array of String 项目管理员
示例值:["1001"]
TaskStrictMode Boolean 调度任务严格模式
示例值:false
ExtraOptions String 以后新增选项可以直接通过前端的json格式写入去实现
示例值:"无"
Model String 项目类型,SIMPLE:简单模式 STANDARD:标准模式
示例值:"SIMPLE"
ProjectOwner.N Array of String 项目负责人
示例值:["1001"]
ModifyType String 更新类型
示例值:gitConfig

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 样例

modify project

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProject
<公共请求参数>

{
    "DisplayName": "bs_test",
    "Description": "bs_test",
    "TaskSubmitApproval": true,
    "ProjectId": "111111111111",
    "ResourcePoolInfo": {
        "ResourcePools": [
            "1234455555"
        ],
        "StorageSize": 0,
        "StorageFileNum": 0,
        "ClusterId": "123123123123",
        "StorageType": "123123123"
    },
    "ProjectManagers": [
        "12312312312"
    ],
    "TaskStrictMode": true,
    "ExtraOptions": "12312312",
    "Model": "123123123"
}

输出示例

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

示例2 modify project

modify project

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProject
<公共请求参数>

{
    "TaskSubmitApproval": "true",
    "ProjectId": "978203585769070592",
    "DisplayName": "bs_test",
    "Description": "bs_test"
}

输出示例

{
    "Response": {
        "RequestId": "72fda28b-e1c8-4017-9fd0-a67c79178bde"
    }
}

示例3 升级到标准模式

升级到标准模式

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProject
<公共请求参数>

{
    "ProjectId": "2082166847290601472",
    "Model": "STANDARD"
}

输出示例

{
    "Response": {
        "RequestId": "059e6ab7-b35c-42be-b1a6-cc0fc1329441"
    }
}

示例4 modify task script ready only

modify project

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyProject
<公共请求参数>

{
    "ProjectId": "1"
}

输出示例

{
    "Response": {
        "RequestId": "64f07492-8c96-4928-a06f-f37c61382e06"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InvalidParameter.WorkspaceNameDuplication 项目名重复。