文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API(v3版本)/ 应用/ 根据应用ID修改应用信息 - ModifyApplicationInformationBasedOnTheApplicationID
更新时间:2026-02-28 GMT+08:00
分享

根据应用ID修改应用信息 - ModifyApplicationInformationBasedOnTheApplicationID

功能介绍

此API用于通过应用ID修改应用信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

URI

PUT /v3/{project_id}/cas/applications/{application_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

application_id

String

参数解释:

应用ID。获取方法,请参考获取所有应用 - ObtainAllApplications

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及

取值范围:

application/json;charset=utf8

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

应用名称。

取值范围:

由英文字母、数字、中划线(-)或下划线(_)组成,并以英文字母开头,英文字母或者数字结尾,长度为2~64个字符。

默认取值:

不涉及

description

String

参数解释:

应用描述。

约束限制:

最大长度为128个字符。

取值范围:

不涉及

默认取值:

不涉及

enterprise_project_id

String

参数解释:

企业项目ID。

约束限制:

需要开通企业项目功能后才可配置企业项目。

取值范围:

不涉及

默认取值:

不涉及

labels

Array of objects

参数解释:

标签,可使用标签管理服务通过标签过滤资源,请参考表4

约束限制:

同一个应用下最多可以添加20个标签。

表4 labels

参数

是否必选

参数类型

描述

key

String

参数解释:

标签名称。

标签用于标识资源,当您拥有相同类型的许多资源时,可以使用标签按各种维度(例如用途、所有者或环境)对资源进行分类。

取值范围:

长度为1到36个字符,只能包含数字、英文字母、下划线(_)、中划线(-)或中文。

默认取值:

不涉及

value

String

参数解释:

标签值。

取值范围:

长度为1到43个字符,只能包含数字、英文字母、下划线(_)、点(.)、中划线(-)或中文。

默认取值:

不涉及

响应消息

表5 响应参数

参数

参数类型

描述

id

String

参数解释:

应用ID。

取值范围:

不涉及

name

String

参数解释:

应用名称。

取值范围:

不涉及

description

String

参数解释:

应用描述。

取值范围:

不涉及

creator

String

参数解释:

应用创建人。

取值范围:

不涉及

project_id

String

参数解释:

项目ID。

取值范围:

不涉及

enterprise_project_id

String

参数解释:

企业项目ID。

取值范围:

不涉及

create_time

Integer

参数解释:

应用创建时间。

取值范围:

不涉及

update_time

Integer

参数解释:

应用修改时间。

取值范围:

不涉及

component_count

Integer

参数解释:

应用下部署的组件个数。

取值范围:

不涉及

labels

Array of objects

参数解释:

标签,可使用标签管理服务通过标签过滤资源,请参考表6

表6 labels

参数

参数类型

描述

key

String

参数解释:

标签名称。

取值范围:

不涉及

value

String

参数解释:

标签值。

取值范围:

不涉及

请求示例

修改应用名称为app-xpmtii2,描述信息修改为test2,标签键值对修改为"key":"var"。

{
    "name": "app-xpmtii2",
    "description": "test2",
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

响应示例

{
    "id": "dae29983-c1e9-437d-a6be-5256076fe605",
    "name": "app-xpmtii2",
    "description": "test2",
    "project_id": "063a3158b1a34710b36ad208b9497d00",
    "creator": "ss-test",
    "create_time": 1679468852302,
    "update_time": 1679470928765,
    "component_count": 0,
    "labels": [
        {
            "key": "key",
            "value": "var"
        }
    ]
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码

相关文档