修改应用的基本信息 | 大装置帮助中心
跳到主要内容

修改应用的基本信息​

修改应用的基本信息

Path Parameters
    subscription_name string required

    订阅

    resource_group_name string required

    资源组

    zone string required

    可用区

    workspace_name string required

    Possible values: <= 63 characters

    工作空间资源名称

    app_name string required

    应用名称

Query Parameters
    update_mask field-mask

    更新应用mask. 1.需要把某个字段置空需要显示指定update_mask, 例如:service.service_port 2.update_mask不支持指定具体哪个容器，故template字段更新时需要全量更新

Request Body required
    name string

    Possible values: non-empty and <= 63 characters

    应用名称. 不填写，则由后台默认随机生成. 若填入,则需要遵循以下规范: 1、1～63个字符 2、小写字母开头，小写字母或数字结尾 3、可包含小写英文字母、数字、中划线-

    display_name string required

    应用显示名称. 填写需要遵循规则: 1、2～128个字符 2、以大小写字母或中文开头 3、可包含数字、点号（.）、下划线（_）、半角冒号（:）或连字符（-）

    ownership object

    所有权关系

    template object

    实例模板

    init_containers object[]

    初始化容器列表

  • Array [
    • name string

    容器名称

    image_path string required

    镜像真实路径

    command string[]

    容器命令列表. 这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell

    env object[]

    容器环境变量列表

  • Array [
    • name string required

    环境变量名称

    value string required

    环境变量值

    need_mosaic boolean required

    需要马赛克

  • ]
    • resource_request object required

    容器资源请求. 若资源请求为空时，取用resource spec的规格

    property name* string
    volume_mounts object[]

    卷挂载

  • Array [
    • type enum required

    Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, CONFIGMAP, SECRET, PV_ACS]

    挂载类型

    name string

    卷名

    mount_path string

    挂载路径

    id string

    AI文件存储配置

    volume_capacity string

    卷容量

    subdir string

    指定挂载卷下的子目录

  • ]
    • liveness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

    readiness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

  • ]
    • containers object[] required

    容器列表

  • Array [
    • name string

    容器名称

    image_path string required

    镜像真实路径

    command string[]

    容器命令列表. 这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell

    env object[]

    容器环境变量列表

  • Array [
    • name string required

    环境变量名称

    value string required

    环境变量值

    need_mosaic boolean required

    需要马赛克

  • ]
    • resource_request object required

    容器资源请求. 若资源请求为空时，取用resource spec的规格

    property name* string
    volume_mounts object[]

    卷挂载

  • Array [
    • type enum required

    Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, CONFIGMAP, SECRET, PV_ACS]

    挂载类型

    name string

    卷名

    mount_path string

    挂载路径

    id string

    AI文件存储配置

    volume_capacity string

    卷容量

    subdir string

    指定挂载卷下的子目录

  • ]
    • liveness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

    readiness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

  • ]
    • resource_spec object required

    资源规格

    name string

    资源规格名称. 根据资源规格列表获取. 例: N2lS.Ie.I60.2

    limits object

    资源列表. key值: CPU(cpu)、内存(memory)、设备数量(device)

    property name* string
    requests object

    资源列表. key值: CPU(cpu)、内存(memory)、设备数量(device)

    property name* string
    elastic_scaling object

    弹性伸缩

    elastic_scaling_on_time object[]

    Possible values: <= 10

    按时间弹性伸缩集合.beta版本

  • Array [
    • name string required

    按时间弹性伸缩策略名称

    display_name string

    按时间弹性伸缩策略显示名称

    id string

    按时间弹性伸缩策略ID

    uid string

    按时间弹性伸缩策略UID

    cycle enum required

    Possible values: [STRATEGY_CYCLE_UNSPECIFIED, STRATEGY_CYCLE_ONCE, STRATEGY_CYCLE_EVERYDAY, STRATEGY_CYCLE_SUNDAY, STRATEGY_CYCLE_MONDAY, STRATEGY_CYCLE_TUESDAY, STRATEGY_CYCLE_WEDNESDAY, STRATEGY_CYCLE_THURSDAY, STRATEGY_CYCLE_FRIDAY, STRATEGY_CYCLE_SATURDAY]

    策略执行周期

    start_time date-time required

    策略开始时间

    end_time date-time

    策略结束时间

    action enum required

    Possible values: [ACTION_TYPE_UNSPECIFIED, SCALE_IN, SCALE_OUT]

    执行动作，分为横向扩容、横向缩容

    replicas_change_each_time int32 required

    Possible values: <= 128

    每次改变副本数

  • ]
    • resource_pool object required

    资源池

    name string

    资源名称

    display_name string

    资源名称

    vpc_id string

    虚拟私有云, 选择公共集群时必填

    available_zone string

    应用实际可用区, 选择公共集群时必填

    scheduling object required

    调度相关

    priority enum required

    Possible values: [PRIORITY_UNSPECIFIED, NORMAL, HIGH, HIGHEST]

    优先级. 默认为普通优先级

    quota_type enum

    Possible values: [QUOTA_TYPE_UNSPECIFIED, RESERVED, SPOT]

    可选, 任务配额类型. 默认为reserved

    hints string[]

    模型缓存调度的 hints

    instance_affinity enum

    Possible values: [POD_AFFINITY_TYPE_UNSPECIFIED, POD_AFFINITY, POD_ANITAFFINITY]

    副本亲和与反亲和，公共集群不可用

    rolling_update_strategy object

    滚动升级策略

    max_surge string

    指定可以超过期望的 Pod 数量的百分比，默认值25%，不能与max_unavailable同时为0

    max_unavailable string

    在升级过程中不可用 Pod 数量的百分比，默认值25%，不能与maxSurge同时为0

    replicas int32

    指定副本数

    termination_grace_period_seconds int32

    停止前的优雅退出时间(秒)

Responses

OK

Schema
    name string

    Possible values: non-empty and <= 63 characters

    应用名称. 不填写，则由后台默认随机生成. 若填入,则需要遵循以下规范: 1、1～63个字符 2、小写字母开头，小写字母或数字结尾 3、可包含小写英文字母、数字、中划线-

    display_name string required

    应用显示名称. 填写需要遵循规则: 1、2～128个字符 2、以大小写字母或中文开头 3、可包含数字、点号（.）、下划线（_）、半角冒号（:）或连字符（-）

    ownership object

    所有权关系

    template object

    实例模板

    init_containers object[]

    初始化容器列表

  • Array [
    • name string

    容器名称

    image_path string required

    镜像真实路径

    command string[]

    容器命令列表. 这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell

    env object[]

    容器环境变量列表

  • Array [
    • name string required

    环境变量名称

    value string required

    环境变量值

    need_mosaic boolean required

    需要马赛克

  • ]
    • resource_request object required

    容器资源请求. 若资源请求为空时，取用resource spec的规格

    property name* string
    volume_mounts object[]

    卷挂载

  • Array [
    • type enum required

    Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, CONFIGMAP, SECRET, PV_ACS]

    挂载类型

    name string

    卷名

    mount_path string

    挂载路径

    id string

    AI文件存储配置

    volume_capacity string

    卷容量

    subdir string

    指定挂载卷下的子目录

  • ]
    • liveness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

    readiness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

  • ]
    • containers object[] required

    容器列表

  • Array [
    • name string

    容器名称

    image_path string required

    镜像真实路径

    command string[]

    容器命令列表. 这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell

    env object[]

    容器环境变量列表

  • Array [
    • name string required

    环境变量名称

    value string required

    环境变量值

    need_mosaic boolean required

    需要马赛克

  • ]
    • resource_request object required

    容器资源请求. 若资源请求为空时，取用resource spec的规格

    property name* string
    volume_mounts object[]

    卷挂载

  • Array [
    • type enum required

    Possible values: [MOUNT_TYPE_UNSPECIFIED, PV_AFS, CONFIGMAP, SECRET, PV_ACS]

    挂载类型

    name string

    卷名

    mount_path string

    挂载路径

    id string

    AI文件存储配置

    volume_capacity string

    卷容量

    subdir string

    指定挂载卷下的子目录

  • ]
    • liveness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

    readiness_probe object

    探针

    probe_type enum required

    Possible values: [PROBE_TYPE_UNSPECIFIED, EXEC, HTTP_GET]

    探针类型，取值exec、目前只支持exec类型，

    exec object

    命令行探针

    command string[] required

    使用命令行方式进行健康检查时，在容器内执行的命令.这个命令并不是在shell中运行,所以传统的shell指令('|'等)是不起作用的。如果要使用shell,您需要明确调用该shell。退出状态码0被视为存活/健康,非0为不健康

    initial_delay_seconds int32

    首次检测延迟，以容器启动完成为起点计算

    period_seconds int32

    检测间隔，检查执行的周期，默认为10秒，最小为1秒

  • ]
    • resource_spec object required

    资源规格

    name string

    资源规格名称. 根据资源规格列表获取. 例: N2lS.Ie.I60.2

    limits object

    资源列表. key值: CPU(cpu)、内存(memory)、设备数量(device)

    property name* string
    requests object

    资源列表. key值: CPU(cpu)、内存(memory)、设备数量(device)

    property name* string
    elastic_scaling object

    弹性伸缩

    elastic_scaling_on_time object[]

    Possible values: <= 10

    按时间弹性伸缩集合.beta版本

  • Array [
    • name string required

    按时间弹性伸缩策略名称

    display_name string

    按时间弹性伸缩策略显示名称

    id string

    按时间弹性伸缩策略ID

    uid string

    按时间弹性伸缩策略UID

    cycle enum required

    Possible values: [STRATEGY_CYCLE_UNSPECIFIED, STRATEGY_CYCLE_ONCE, STRATEGY_CYCLE_EVERYDAY, STRATEGY_CYCLE_SUNDAY, STRATEGY_CYCLE_MONDAY, STRATEGY_CYCLE_TUESDAY, STRATEGY_CYCLE_WEDNESDAY, STRATEGY_CYCLE_THURSDAY, STRATEGY_CYCLE_FRIDAY, STRATEGY_CYCLE_SATURDAY]

    策略执行周期

    start_time date-time required

    策略开始时间

    end_time date-time

    策略结束时间

    action enum required

    Possible values: [ACTION_TYPE_UNSPECIFIED, SCALE_IN, SCALE_OUT]

    执行动作，分为横向扩容、横向缩容

    replicas_change_each_time int32 required

    Possible values: <= 128

    每次改变副本数

  • ]
    • resource_pool object required

    资源池

    name string

    资源名称

    display_name string

    资源名称

    vpc_id string

    虚拟私有云, 选择公共集群时必填

    available_zone string

    应用实际可用区, 选择公共集群时必填

    scheduling object required

    调度相关

    priority enum required

    Possible values: [PRIORITY_UNSPECIFIED, NORMAL, HIGH, HIGHEST]

    优先级. 默认为普通优先级

    quota_type enum

    Possible values: [QUOTA_TYPE_UNSPECIFIED, RESERVED, SPOT]

    可选, 任务配额类型. 默认为reserved

    hints string[]

    模型缓存调度的 hints

    instance_affinity enum

    Possible values: [POD_AFFINITY_TYPE_UNSPECIFIED, POD_AFFINITY, POD_ANITAFFINITY]

    副本亲和与反亲和，公共集群不可用

    rolling_update_strategy object

    滚动升级策略

    max_surge string

    指定可以超过期望的 Pod 数量的百分比，默认值25%，不能与max_unavailable同时为0

    max_unavailable string

    在升级过程中不可用 Pod 数量的百分比，默认值25%，不能与maxSurge同时为0

    replicas int32

    指定副本数

    termination_grace_period_seconds int32

    停止前的优雅退出时间(秒)

PATCH /compute/cci/data/v2/subscriptions/:subscription_name/resourceGroups/:resource_group_name/zones/:zone/workspaces/:workspace_name/apps/:app_name

Authorization

name: bearerAuthtype: httpscheme: bearer

Request

Base URL
https://cci.cn-sh-01.sensecore.cn
Bearer Token
subscription_name — path required
resource_group_name — path required
zone — path required
workspace_name — path required
app_name — path required
update_mask — query
Body required
{

  "name": "string",

  "display_name": "string",

  "ownership": {},

  "template": {

    "init_containers": [

      {

        "name": "string",

        "image_path": "string",

        "command": [

          "string"

        ],

        "env": [

          {

            "name": "string",

            "value": "string",

            "need_mosaic": true

          }

        ],

        "resource_request": {},

        "volume_mounts": [

          {

            "type": "MOUNT_TYPE_UNSPECIFIED",

            "name": "string",

            "mount_path": "string",

            "id": "string",

            "volume_capacity": "string",

            "subdir": "string"

          }

        ],

        "liveness_probe": {

          "probe_type": "PROBE_TYPE_UNSPECIFIED",

          "exec": {

            "command": [

              "string"

            ]

          },

          "initial_delay_seconds": 0,

          "period_seconds": 0

        },

        "readiness_probe": {

          "probe_type": "PROBE_TYPE_UNSPECIFIED",

          "exec": {

            "command": [

              "string"

            ]

          },

          "initial_delay_seconds": 0,

          "period_seconds": 0

        }

      }

    ],

    "containers": [

      {

        "name": "string",

        "image_path": "string",

        "command": [

          "string"

        ],

        "env": [

          {

            "name": "string",

            "value": "string",

            "need_mosaic": true

          }

        ],

        "resource_request": {},

        "volume_mounts": [

          {

            "type": "MOUNT_TYPE_UNSPECIFIED",

            "name": "string",

            "mount_path": "string",

            "id": "string",

            "volume_capacity": "string",

            "subdir": "string"

          }

        ],

        "liveness_probe": {

          "probe_type": "PROBE_TYPE_UNSPECIFIED",

          "exec": {

            "command": [

              "string"

            ]

          },

          "initial_delay_seconds": 0,

          "period_seconds": 0

        },

        "readiness_probe": {

          "probe_type": "PROBE_TYPE_UNSPECIFIED",

          "exec": {

            "command": [

              "string"

            ]

          },

          "initial_delay_seconds": 0,

          "period_seconds": 0

        }

      }

    ],

    "resource_spec": {

      "name": "string"

    }

  },

  "elastic_scaling": {

    "elastic_scaling_on_time": [

      {

        "name": "string",

        "display_name": "string",

        "id": "string",

        "uid": "string",

        "cycle": "STRATEGY_CYCLE_UNSPECIFIED",

        "start_time": "2025-04-23T03:43:49.099Z",

        "end_time": "2025-04-23T03:43:49.099Z",

        "action": "ACTION_TYPE_UNSPECIFIED",

        "replicas_change_each_time": 0

      }

    ]

  },

  "resource_pool": {

    "name": "string",

    "display_name": "string",

    "vpc_id": "string",

    "available_zone": "string"

  },

  "scheduling": {

    "priority": "PRIORITY_UNSPECIFIED",

    "quota_type": "QUOTA_TYPE_UNSPECIFIED",

    "hints": [

      "string"

    ],

    "instance_affinity": "POD_AFFINITY_TYPE_UNSPECIFIED"

  },

  "rolling_update_strategy": {

    "max_surge": "string",

    "max_unavailable": "string"

  },

  "replicas": 0,

  "termination_grace_period_seconds": 0

}
curl / cURL
curl -L -X PATCH 'https://cci.cn-sh-01.sensecore.cn/compute/cci/data/v2/subscriptions/:subscription_name/resourceGroups/:resource_group_name/zones/:zone/workspaces/:workspace_name/apps/:app_name' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "name": "string",
  "display_name": "string",
  "ownership": {},
  "template": {
    "init_containers": [
      {
        "name": "string",
        "image_path": "string",
        "command": [
          "string"
        ],
        "env": [
          {
            "name": "string",
            "value": "string",
            "need_mosaic": true
          }
        ],
        "resource_request": {},
        "volume_mounts": [
          {
            "type": "MOUNT_TYPE_UNSPECIFIED",
            "name": "string",
            "mount_path": "string",
            "id": "string",
            "volume_capacity": "string",
            "subdir": "string"
          }
        ],
        "liveness_probe": {
          "probe_type": "PROBE_TYPE_UNSPECIFIED",
          "exec": {
            "command": [
              "string"
            ]
          },
          "initial_delay_seconds": 0,
          "period_seconds": 0
        },
        "readiness_probe": {
          "probe_type": "PROBE_TYPE_UNSPECIFIED",
          "exec": {
            "command": [
              "string"
            ]
          },
          "initial_delay_seconds": 0,
          "period_seconds": 0
        }
      }
    ],
    "containers": [
      {
        "name": "string",
        "image_path": "string",
        "command": [
          "string"
        ],
        "env": [
          {
            "name": "string",
            "value": "string",
            "need_mosaic": true
          }
        ],
        "resource_request": {},
        "volume_mounts": [
          {
            "type": "MOUNT_TYPE_UNSPECIFIED",
            "name": "string",
            "mount_path": "string",
            "id": "string",
            "volume_capacity": "string",
            "subdir": "string"
          }
        ],
        "liveness_probe": {
          "probe_type": "PROBE_TYPE_UNSPECIFIED",
          "exec": {
            "command": [
              "string"
            ]
          },
          "initial_delay_seconds": 0,
          "period_seconds": 0
        },
        "readiness_probe": {
          "probe_type": "PROBE_TYPE_UNSPECIFIED",
          "exec": {
            "command": [
              "string"
            ]
          },
          "initial_delay_seconds": 0,
          "period_seconds": 0
        }
      }
    ],
    "resource_spec": {
      "name": "string"
    }
  },
  "elastic_scaling": {
    "elastic_scaling_on_time": [
      {
        "name": "string",
        "display_name": "string",
        "id": "string",
        "uid": "string",
        "cycle": "STRATEGY_CYCLE_UNSPECIFIED",
        "start_time": "2025-04-23T03:43:49.099Z",
        "end_time": "2025-04-23T03:43:49.099Z",
        "action": "ACTION_TYPE_UNSPECIFIED",
        "replicas_change_each_time": 0
      }
    ]
  },
  "resource_pool": {
    "name": "string",
    "display_name": "string",
    "vpc_id": "string",
    "available_zone": "string"
  },
  "scheduling": {
    "priority": "PRIORITY_UNSPECIFIED",
    "quota_type": "QUOTA_TYPE_UNSPECIFIED",
    "hints": [
      "string"
    ],
    "instance_affinity": "POD_AFFINITY_TYPE_UNSPECIFIED"
  },
  "rolling_update_strategy": {
    "max_surge": "string",
    "max_unavailable": "string"
  },
  "replicas": 0,
  "termination_grace_period_seconds": 0
}'