You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘托管/API 参考/返回结构定义
返回结构定义
最近更新时间：2023.10.09 20:56:11首次发布时间：2023.08.24 19:59:31
我的收藏

ClusterResponse

参数名

参数类型

示例值

说明

Id

String

cc5silumrsfeq****

集群 ID。

CreateClientToken

String

BusinessRequest12345

创建成功时的ClientToken。
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

UpdateClientToken

String

BusinessRequest54321

最后一次更新成功时ClientToken。
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

CreateTime

String

2022-05-06T02:49:19Z

集群创建时间。标准 RFC3339 格式的 UTC+0 时间。

UpdateTime

String

2022-05-15T03:13:20Z

集群最后一次接纳请求，并执行或执行完成的时间。标准 RFC3339 格式的 UTC+0 时间。

KubernetesVersion

String

v1.20.10-vke.2

集群对应的 Kubernetes 版本信息，具体到 patch version。

Name

String

test-cluster

集群名称。

Description

String

集群描述信息。

Status

ClusterStatusResponse

集群状态。详细说明，请参见ClusterStatusResponse。

DeleteProtectionEnabled

Boolean

false

集群删除保护，参数值说明：

  • true：已开启删除保护
  • false：已关闭删除保护

ClusterConfig

ClusterConfigResponse

集群控制面及部分节点的网络配置。详细说明，请参见ClusterConfigResponse。

PodsConfig

PodsConfigResponse

Pod的网络配置。详细说明，请参见PodsConfigResponse。

ServicesConfig

ServicesConfigResponse

服务的网络配置。详细说明，请参见ServicesConfigResponse。

NodeStatistics

EdgeNodeStatistics

集群中各主状态下对应的节点数量统计。详细说明，请参见EdgeNodeStatistics。

Tags

[]TagResponse

集群绑定标签信息。

LoggingConfig

ClusterLoggingConfigResponse

集群的日志配置信息。

TagResponse

参数名

参数类型

示例值

说明

Key

String

key1

标签键。

Value

String

value1

标签值。

Type

String

System

标签类型：

  • System 系统标签；
  • Custom 用户自定义标签

ClusterStatusResponse

参数名

参数类型

示例值

说明

Phase

String

Running

集群的状态。参数值有：

  • Creating
  • Running
  • Updating
  • Deleting
  • Stopped
  • Failed

Conditions

[]ClusterStatusConditionResponse

集群当前主状态下的状态条件，即进入该主状态的原因。详细说明，请参见ClusterStatusConditionResponse。

ClusterStatusConditionResponse

集群的状态

参数名

参数类型

示例值

说明

Type

String

集群当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：

  • Progressing
  • Ok
  • Degraded
  • SetByProvider
  • Balance
  • Security
  • CreateError
  • LimitedByQuota
  • StockOut
  • Balance
  • ResourceCleanupFailed
  • Unknown

ClusterConfigResponse

参数名

参数类型

示例值

说明

VpcId

String

集群控制面及部分节点的网络所在的私有网络（VPC）ID。

SubnetIds

[]String

集群控制面在私有网络（VPC）内通信的子网 ID。

SecurityGroupIds

[]String

集群控制面及节点使用的的安全组。

ApiServerPublicAccessEnabled

Boolean

集群 API Server公网访问配置，参数值说明：

  • false：（默认值）关闭
  • true：开启

ApiServerPublicAccessConfig

PublicAccessConfigResponse

ApiServerPublicAccessEnable=true时返回的参数。详细说明，请参见PublicAccessConfigResponse。

ResourcePublicAccessDefaultEnabled

Boolean

节点公网访问配置，参数值说明“

  • false：未开启公网访问。
  • true：已开启公网访问。

ApiServerEndpoints

ClusterApiServerEndpointsResponse

集群 API Server 访问的 Endpoint 信息。

PublicAccessConfigResponse

参数名

参数类型

示例值

说明

PublicAccessNetworkConfig

EipConfigResponse

公网访问网络配置。ApiServerPublicAccessEnable=true时才返回的参数。

AccessSourceIpsv4

[]String

IPv4 的公网访问白名单，空值代表全开（0.0.0.0/0）。

PodsConfigResponse

参数名

参数类型

示例值

说明

PodNetworkMode

String

容器网络模型，参数值说明：

  • Flannel：Flannel 网络模式
  • VpcCniShared：VPC-CNI 共享 ENI 模式

FlannelConfig

FlannelConfigResponse

Flannel 网络配置，详细说明，请参见FlannelConfigResponse。

VpcCniConfig

VpcCniConfigResponse

VPC-CNI网络配置，详细说明，请参见VpcCniConfigResponse。

VpcCniConfigResponse

参数名

参数类型

示例值

说明

SubnetIds

[]String

VPC-CNI 模型容器网络的 Pod 子网 ID 列表。

FlannelConfigResponse

参数名

参数类型

示例值

说明

PodCidrs

[]String

Flannel 模型容器网络的 Pod CIDR。

MaxPodsPerNode

Integer

64

Flannel 模型容器网络的单节点 Pod实例数量上限。

ClusterApiServerEndpointsResponse

参数名

参数类型

示例值

说明

PrivateIp

EndpointResponse

集群 API Server 私网的 Endpoint 地址。详细信息，请参见EndpointResponse。

PublicIp

EndpointResponse

集群 API Server 公网的 Endpoint 地址，详细信息，请参见EndpointResponse。

EndpointResponse

参数名

参数类型

示例值

说明

Ipv4

String

Endpoint 的 IPv4 地址。

ServicesConfigResponse

参数名

参数类型

示例值

说明

ServiceCidrsv4

[]String

服务暴露的 IPv4 私有网络地址。

EipConfigResponse

参数名

参数类型

示例值

说明

BillingType

Integer

2

公网 IP 的计费类型

  • 2：按量计费-按带宽上限计费
  • 3：（默认值）按量计费-按实际流量计费

Bandwidth

Integer

1

公网IP的带宽峰值，单位：Mbps。

Isp

String

BGP

公网 IP 的线路类型，取值：

  • BGP：BGP（多线）。

ClusterLoggingConfigResponse

参数名

参数类型

示例值

说明

LogSetups

LogSetupResponse

集群的日志选项信息。

LogProjectId

String

b68324a0-2680-48c7-a42e-8d78********

集群的日志项目（Log Project）ID。
如果为空，表示集群的日志项目未被创建。

LogSetupResponse

参数名

参数类型

示例值

说明

LogType

String

Audit

当前开启的日志类型，参数值有：
Audit：集群审计日志

LogTtl

Integer

30

日志在日志服务中的保存时间，单位为天。 3650 天表示永久存储。

LogTopicId

String

d94b4eb4-1108-4931-86e7-2660********

采集目标的TLS日志主题ID。
如果为空，表示对应日志的主题未被创建。

Enabled

Boolean

false

是否开启该日志选项，参数值有：

  • true：已开启
  • false：未开启

SupportedResourceTypesResponse

说明

当需要查询 ECS 某种实例规格所对应的可以挂载的 VolumeType 的关系时，请调用 ECS 的 OpenAPI：DescribeInstanceTypes接口取得对应的关系。

参数名称

类型

示例值

描述

ResourceScope

String

Zone

资源所属范围，参数值说明：

  • Zone ：可用区
  • Region ：地域

ZoneId

String

资源所支持的具体ZoneId。

ResourceType

String

资源类型，参数值说明：

  • Ecs：ECS 资源
  • Zone : 可用区资源

ResourceSpecifications

[]String

资源的对应规格列表，如 ECS 的InstanceTypeId。

EdgeNodePool

名称

类型

示例值

描述

Id

String

节点池 ID。

Name

String

节点池名称。

ClusterId

String

集群 ID。

KubernetesConfig

EdgeNodePoolKubernetesConfig

Kubernetes配置。。

Status

EdgeNodePoolStatus

节点池状态。

NodeStatistics

EdgeNodeStatistics

节点池节点统计

CreateTime

String

创建时间。

UpdateTime

String

更新时间

CreateClientToken

String

创建幂等 Token。

UpdateClientToken

String

更新幂等 Token。

Profile

String

Edge

Edge：边缘节点池。
返回值为空则为中心节点池。

Type

String

edge-machine-pool

machine-set：中心节点池
edge-machine-set：边缘节点池
edge-machine-pool：边缘弹性节点池

ElasticConfig

ElasticConfig

节点池弹性扩缩容配置。

EdgeNodePoolKubernetesConfig

名称

类型

示例值

描述

Labels

[]Label

[
      {
        "Key": "IDC",
        "Value": "BeiJing"
      },
      {
        "Key": "GPU",
        "Value": "true"
      }
]

Taints

[]Taint

[
      {
        "Value": "Error",
        "Key": "Status",
        "Effect": "NoSchedule"
      }
]

NodePoolType

String

edge-machine-set：边缘节点池
edge-machine-pool：边缘弹性节点池

ElasticConfig

ElasticConfig

{
    "CloudServerIdentity": "cloudserver-w*******",
    "AutoScaleConfig": {
      "Enabled": true,
      "MinReplicas": 1,
      "MaxReplicas": 10,
      "Priority": 10,
      "DesiredReplicas": 1
    },
    "InstanceArea": {
      "ClusterName": "bdcdn-hsct02",
      "DesiredReplicas": 1
    }
  }

Label

名称

类型

示例值

描述

Key

String

IDC

标签键。

Value

String

BeiJing

标签值。

Taint

名称

类型

示例值

描述

Key

String

Error

污点键。

Value

String

Status

污点值。

Effect

String

NoSchedule（默认值）：一定不能被调度
PreferNoSchedule：尽量不要调度
NoExecute：不仅不会调度，还会驱逐Node上已有的Pod

污点效果，参数值说明：

  • NoSchedule：不调度。
  • NoExecute：驱逐没有容忍污点的 Pod。
  • PreferNoSchedule：尽量避免调度。

EdgeNodePoolStatus

名称

类型

示例值

描述

Phase

String

Ok

取值范围如下：

  • Ok
  • StockOut
  • LimitedByQuota
  • Balance
  • VersionPartlyUpgraded
  • ResourceCleanupFailed
  • ClusterNotRunning
  • Unknown
  • Progressing
  • ClusterVersionUpgrading

Conditions

[]EdgeNodePoolStatusCondition

EdgeNodePoolStatusCondition

名称

类型

示例值

描述

Type

String

Ok

取值范围如下：

  • Ok
  • StockOut
  • LimitedByQuota
  • Balance
  • VersionPartlyUpgraded
  • ResourceCleanupFailed
  • ClusterNotRunning
  • Unknown
  • Progressing
  • ClusterVersionUpgrading

EdgeNodeStatistics

名称

类型

示例值

描述

TotalCount

Integer

10

节点总数量。

CreatingCount

Integer

2

Phase=Creating的节点总数量。

RunningCount

Integer

2

Phase=Running的节点总数量。

UpdatingCount

Integer

2

Phase=Updating的节点总数量。

DeletingCount

Integer

1

Phase=Deleting的节点总数量。

FailedCount

Integer

1

Phase=Failed的节点总数量。

StoppedCount

Integer

1

Phase=Stopped的节点总数量。

StoppingCount

Integer

1

Phase=Stopping的节点总数量。

StartingCount

Integer

1

Phase=Starting的节点总数量。

ElasticConfig

名称

类型

示例值

描述

CloudServerIdentity

String

234agdagd53****

AutoScaleConfig

AutoSaleConfig

{
"Enabled": true,
"MinReplicas": 1,
"MaxReplicas": 10,
"Priority": 10,
"DesiredReplicas": 1
}

InstanceArea

InstanceArea

{
"ClusterName": "bdcdn-hsct02",
"DesiredReplicas": 1
}

EdgeNode

名称

类型

示例值

描述

Id

String

nc6h6epmrsf****

节点 ID。

Name

String

test-node

节点名称。

ClusterId

String

cc6halumrsfeq****

集群 ID。

NodePoolId

String

pc8oah9cbcv****

节点池 ID。

Status

EdgeNodeStatus

节点状态。

CreateTime

String

2021-10-27T10:33:30Z

创建时间。

UpdateTime

String

2021-10-29T10:33:30Z

更新时间

CreateClientToken

String

BC028527-33B9-4990-A633-84E9F9******

创建成功时的 ClientToken。
ClientToken 是保证请求幂等性的字符串。该字符串由调用方传入。

BootstrapScript

String

边缘节点纳管脚本。

Profile

String

Edge

区分边缘/中心节点。

EdgeNodeType

String

边缘节点类型：边缘计算节点/自有节点。取值范围如下：

  • BatchEdgeMachine
  • VEEdgeNode
  • VEEdgeElasticNode
  • PrivateEdgeNode

ProviderId

String

Provider ID。

InstanceId

String

实例 ID。

EdgeNodeStatus

名称

类型

示例值

描述

Phase

String

Running

取值范围如下：

  • Creating
  • Running
  • Deleting
  • Updating
  • Failed
  • Stopping
  • Stopped
  • Starting

Conditions

[]EdgeNodeStatusCondition

节点当前主状态下的状态条件，即进入该主状态的原因。

EdgeNodeStatusCondition

名称

类型

示例值

描述

Type

String

Ok

节点当前主状态下的状态条件，即进入该主状态的原因，可以有多个原因，参数值有：

  • Ok
  • Unschedulable
  • NotReady
  • InitializeFailed
  • ResourceCleanupFailed
  • Security
  • Balance
  • Unknown
  • Progressing

BatchEdgeNode

名称

类型

示例值

描述

Id

String

节点ID。

Name

String

节点名称。

ClusterId

String

集群 ID。

NodePoolId

String

节点池ID。

Status

EdgeNodeStatus

节点状态。

CreateTime

String

创建时间

UpdateTime

String

更新时间。

CreateClientToken

String

创建幂等 Token。

BootstrapScript

String

边缘节点纳管脚本。

Profile

String

区分边缘/中心节点。

EdgeNodeType

String

边缘节点类型：边缘计算节点/自有节点。取值范围如下：

  • BatchEdgeMachine
  • VEEdgeNode
  • VEEdgeElasticNode
  • PrivateEdgeNode

TTLTime

Integer

过期时间。