华为云用户手册

  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "clusters" : [ { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "create_time" : "string", "update_time" : "string", "is_upgradeable" : true } ] }
  • URI GET /v3/{project_id}/clusters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 cluster_name 否 String 边缘集群名称 最小长度:1 最大长度:32 state 否 String 边缘集群状态 最小长度:1 最大长度:32 cluster_ids 否 Array 边缘集群ID列表 数组长度:0 - 1000 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0。 最小值:0 最大值:1000000 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 clusters Array of QueryClusterBriefResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryClusterBriefResponseDTO 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度:4 最大长度:32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 is_upgradeable Boolean 是否可升级
  • 响应示例 状态码: 200 OK { "id" : "string", "namespace" : "string", "version" : "string", "app_id" : "string", "app_version" : "string", "status" : "string", "status_description" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" }
  • 请求示例 PUT https://{endpoint}/v2/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id} { "action" : "string", "namespace" : "string", "app_version" : "string", "values" : { }, "rollback_version" : "string" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 应用实例ID namespace String 边缘集群命名空间 version String 应用实例版本 app_id String 应用ID app_version String 应用版本 status String 应用实例状态 status_description String 状态描述 values Object 应用实例chart配置 create_time String 创建时间 update_time String 最后一次更新时间
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 动作类型 namespace 否 String 命名空间,应用实例部署于非默认命名空间(default)时必填 最小长度:1 最大长度:63 app_version 否 String 升级的目标版本号,动作类型为upgrade时必填 最小长度:1 最大长度:32 values 否 Object 应用实例chart配置,动作类型为upgrade时必填 rollback_version 否 String 回退的目标版本号,动作类型为rollback时必填 最小长度:1 最大长度:32
  • URI PUT /v3/{project_id}/clusters/{cluster_id}/app-instances/{app_instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 cluster_id 是 String 边缘集群ID 最小长度:1 最大长度:64 app_instance_id 是 String 应用实例ID 最小长度:1 最大长度:24
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_versions" : [ { "app_id" : "string", "version" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 app_versions Array of QueryAppVersionResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppVersionResponseDTO 参数 参数类型 描述 app_id String 应用模板ID version String 应用版本 values Object 应用版本配置 create_time String 创建时间 update_time String 最后一次修改时间
  • URI GET /v3/{project_id}/apps/{app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 version 否 String 应用版本号 最小长度:1 最大长度:32 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0。 最小值:0 最大值:1000000 缺省值:0
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_id String 应用模板ID 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 app_type String 应用类型 最小长度:0 最大长度:64 provider_type String 应用来源 最小长度:0 最大长度:64 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "count" : 1000000, "page_info" : { "offset" : 1000000, "limit" : 1000 }, "app_images" : [ { "image_namespace" : "iot", "name" : "edge_manager", "tag" : "1.0.0", "digest" : "sha256:38f3f34301cec3cabd9de3f65f2b313ed7e44d6b211254e7156d12229c5b459f", "create_time" : "string" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 app_images Array of QueryAppImageResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppImageResponseDTO 参数 参数类型 描述 image_namespace String 镜像组织 name String 镜像仓库名称 tag String 镜像tag digest String 镜像摘要 create_time String 创建时间
  • URI GET /v3/{project_id}/apps/{app_id}/versions/{version}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 version 是 String 应用版本 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页记录数,默认值为10,取值区间为1-1000。 最小值:1 最大值:1000 缺省值:10 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0。 最小值:0 最大值:1000000 缺省值:0
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度:4 最大长度:32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 os String 操作系统 arch String 集群架构 license LicenseInfo object license信息 resource_id String 资源id create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 表4 LicenseInfo 参数 参数类型 描述 esn String esn码 最小长度:1 最大长度:256 expire_time String 超期时间 最小长度:1 最大长度:256 grace_time String 宽限期 最小长度:0 最大长度:256
  • 响应示例 状态码: 200 OK { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "os" : "string", "arch" : "string", "create_time" : "string", "update_time" : "string", "license" : "string" }
  • 响应示例 状态码: 200 OK { "nodes" : [ { "name" : "string", "internal_ip" : "string", "hostname" : "string", "allocatable" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "capacity" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "allocated_resources" : { "request" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 }, "limit" : { "cpu" : 0, "memory" : 0, "storage" : 0, "pods" : 0 } }, "status" : "string", "architecture" : "string", "labels" : { }, "node_type" : "string", "kernel_version" : "string", "os_image" : "string", "container_runtime_version" : "string", "kubernetes_version" : "string", "create_time" : "string" } ] }
  • 响应示例 状态码: 201 Created { "cluster_id" : "123343534", "cluster_name" : "test-cluster", "description" : "this is a test cluster", "version" : "string", "state" : "string", "create_time" : "string", "update_time" : "string", "is_upgradeable" : true }
  • 请求示例 GET https://{endpoint}/v3/{project_id}/clusters { "cluster_name" : "test-cluster", "description" : "this is a test cluster", "cluster_node_config" : { "master_node_vip" : "string", "master_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ], "work_nodes" : [ { "node_ip" : "string", "node_name" : "string" } ] } }
  • 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 cluster_id String 集群ID cluster_name String 集群名称 最小长度:4 最大长度:32 description String 集群描述 version String 边缘集群版本 state String 边缘集群状态 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256 is_upgradeable Boolean 是否可升级
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 cluster_name 是 String 集群名称 最小长度:4 最大长度:32 description 否 String 集群描述 最小长度:0 最大长度:1024 cluster_node_config 否 ClusterNodeConfig object 集群节点配置 表4 ClusterNodeConfig 参数 是否必选 参数类型 描述 master_node_vip 否 String master虚拟ip 最小长度:1 最大长度:64 master_nodes 否 Array of NodeConfig objects master节点数 work_nodes 否 Array of NodeConfig objects work节点数 表5 NodeConfig 参数 是否必选 参数类型 描述 node_ip 否 String 节点IP 最小长度:1 最大长度:64 node_name 否 String 节点名称 最小长度:1 最大长度:64
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID 最小长度:4 最大长度:32 app_name 否 String 应用名称 最小长度:4 最大长度:64 description 否 String 应用描述 最小长度:1 最大长度:255 app_type 是 String 应用类型 最小长度:1 最大长度:64
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 app_id String 应用模板ID 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 app_type String 应用类型 最小长度:0 最大长度:64 provider_type String 应用来源 最小长度:0 最大长度:64 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_instances Array of QueryAppInstanceResp objects 应用实例列表 数组长度:0 - 1000 表4 QueryAppInstanceResp 参数 参数类型 描述 id String 应用实例ID namespace String 边缘集群命名空间 version String 应用实例版本 app_id String 应用ID app_version String 应用版本 status String 应用实例状态 status_description String 状态描述 values Object 应用实例chart配置 create_time String 创建时间 update_time String 最后一次更新时间
  • 响应示例 状态码: 200 OK { "app_instances" : [ { "id" : "string", "namespace" : "string", "version" : "string", "app_id" : "string", "app_version" : "string", "status" : "string", "status_description" : "string", "values" : { }, "create_time" : "string", "update_time" : "string" } ] }
  • URI POST /v3/{project_id}/apps/{app_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 version 是 String 应用版本 最小长度:1 最大长度:32
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表4 FormData参数 参数 是否必选 参数类型 描述 chart 是 File chart包。当前仅支持tgz文件格式。 images 否 String 应用包含的镜像列表
  • URI GET /v3/{project_id}/apps/{app_id}/versions/{version}/archive 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 app_id 是 String 应用ID 最小长度:1 最大长度:32 version 是 String 应用版本 最小长度:1 最大长度:32
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 apps Array of QueryAppBriefResponseDTO objects 每页记录数 数组长度:0 - 1000000 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 QueryAppBriefResponseDTO 参数 参数类型 描述 app_id String 应用模板ID 最小长度:1 最大长度:64 description String 应用描述 最小长度:0 最大长度:256 app_type String 应用类型 最小长度:0 最大长度:64 provider_type String 应用来源 最小长度:0 最大长度:64 create_time String 创建时间 最小长度:0 最大长度:256 update_time String 最后一次修改时间 最小长度:0 最大长度:256
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全