文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 应用/ 根据应用ID修改应用信息
更新时间：2024-12-04 GMT+08:00
查看PDF
分享

根据应用ID修改应用信息

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

application_id

是

String

应用ID。获取方法，请参考获取所有应用。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写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

标签值。

长度为2到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

内部错误。

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 应用

相关文档