文档中心 容器服务 API 文档 集群相关接口 DescribeClusterEndpointVipStatus

DescribeClusterEndpointVipStatus

最近更新时间:2019-11-21 17:52:32

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

查询集群开启端口流程状态(仅支持托管集群外网端口)

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeClusterEndpointVipStatus
Version String 公共参数,本接口取值:2018-05-25
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群ID

3. 输出参数

参数名称 类型 描述
Status String 端口操作状态 (Creating 创建中 CreateFailed 创建失败 Created 创建完成 Deleting 删除中 DeletedFailed 删除失败 Deleted 已删除 NotFound 未发现操作 )
ErrorMsg String 操作失败的原因
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群开启端口流程状态

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeClusterEndpointVipStatus
&ClusterId=cls-xxxxxxxx,
&<公共请求参数>

输出示例

{
  "Response": {
    "Status": "Creating",
    "ErrorMsg": "",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.AsCommon 伸缩组资源创建报错。
InternalError.CamNoAuth 没有权限。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误
InternalError.DbRecordNotFound 记录未找到。
InternalError.DfwGetUSGCount 获得当前安全组总数失败。
InternalError.DfwGetUSGQuota 获得安全组配额失败。
InternalError.ImageIdNotFound 镜像未找到。
InternalError.Param Param。
InternalError.UnexceptedInternal 内部错误
InvalidParameter 参数错误
InvalidParameter.AsCommonError 弹性伸缩组创建参数错误。
InvalidParameter.Param 参数错误。
ResourceInUse 资源被占用
ResourceNotFound 资源不存在
ResourceUnavailable 资源不可用
UnsupportedOperation 操作不支持