You need to enable JavaScript to run this app.
导航
应用部署前资源检查
最近更新时间:2024.06.25 16:32:14首次发布时间:2024.01.15 15:04:13

本接口用于应用部署前资源检查。为提高容器部署成功率,创建边缘应用和部署应用前,您必须进行资源检查。检查不通过的部署节点,将无法被成功部署,后续操作时请注意删除未通过资源检查的部署节点。

请求说明

  • 请求方式:POST
  • 请求地址:https://veecc.volcengineapi.com/?Action=CheckAppResource&Version=2022-10-01

请求参数

参数

类型

是否必选

示例值

描述

Action

String

CheckAppResource

要执行的操作。取值:CheckAppResource。

check_type

String

deploy_app_version

检查类型。取值范围:

  • create_app:创建应用时资源检查
  • deploy_app_version:应用部署时资源检查

create_app

CreateApplicationParam

参考 CreateApplicationParam

创建应用时资源检查必填,结构和创建边缘应用接口的请求参数一致。

deploy_app_version

DeployAppVersionParam

参考 DeployAppVersionParam

部署应用时资源检查必填,结构和部署指定应用版本接口的请求参数一致。

返回参数

参数

类型

示例值

描述

items

[ ]ResourceAvailableItem

请参见返回示例

资源检查结果项列表。

请求示例

POST https://veecc.volcengineapi.com/?Action=CheckAppResource
&<公共请求参数>
{
  "check_type": "deploy_app_version",
  "deploy_app_version": {
    "app_id": "veecc-3017320007013313****",
    "version_no": "1.0.0"
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023103111223175698A584A3932F3****",
    "Action": "CheckAppResource",
    "Version": "2022-10-01",
    "Service": "veecc",
    "Region": "cn-north-1"
  },
  "Result": {
    "items": [
        {
          "resource_type": "pod_ip",
          "available": true,
          "app_placements": null,
          "reg_prov_isp_policies": null
        },
        {
          "resource_type": "computing_resource",
          "available": true,
          "app_placements": null,
          "reg_prov_isp_policies": null
        },
        {
          "resource_type": "cluster",
          "available": true,
          "app_placements": null,
          "reg_prov_isp_policies": null
        }
      ]
  }
}

错误码

如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见公共错误码