GetK8sAppPrecheckResult - 获取K8s应用预检结果

调用GetK8sAppPrecheckResult接口获取K8s应用预检结果。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadClusterget
*全部资源
*

请求语法

GET /pop/v5/k8s/app_precheck HTTP/1.1

请求参数

名称类型必填描述示例值
ClusterIdstring

EDAS 集群 ID。

c37aec2a-bcca-4ec1-****-************
Namespacestring

K8s 集群命名空间。

default
AppNamestring

应用名称。

testapp

返回参数

名称类型描述示例值
object

应用变更预检响应。

RequestIdstring

请求 ID。

B909AB1F-3763-4963-B1CE-0BDFA192****
Codeinteger

接口状态或 POP 错误码。

200
Messagestring

附加信息。

success
Dataobject

接口响应数据。

Statusstring

应用变更预检状态:

  • checking:检查中。
  • pass:通过检查。
  • failed:未通过检查。
checking
Reasonstring

应用变更预检未通过的原因说明。预检通过时该字段为空。

K8s集群失联。
JobResultsarray<object>

应用变更预检结果。

JobResultsobject

应用变更预检结果对象。

Namestring

预检任务项名称。

Cluster Health Check
Passboolean

预检任务项是否通过预检:

  • true:通过预检。
  • false:未通过预检。
true
Interruptedboolean

预检任务项是否被中断:

  • true:任务被中断。
  • false:任务未被中断。
false
Reasonstring

应用变更预检项未通过或被中断的原因说明。预检通过时该字段为空。

K8s集群失联。

示例

正常返回示例

JSON格式

{
  "RequestId": "B909AB1F-3763-4963-B1CE-0BDFA192****",
  "Code": 200,
  "Message": "success",
  "Data": {
    "Status": "checking",
    "Reason": "K8s集群失联。",
    "JobResults": [
      {
        "Name": "Cluster Health Check",
        "Pass": true,
        "Interrupted": false,
        "Reason": "K8s集群失联。"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
500Edas.errorcode.PermissionDenied.messageYou are not authorized to perform the operation.无权限操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-07-04新增 OpenAPI查看变更详情