容器服务查询托管集群开启外网端口流程状态

1. 接口描述

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

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterEndpointVipStatus。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cls-2wds9k9p

3. 输出参数

参数名称	类型	描述
Status	String	端口操作状态 (Creating 创建中 CreateFailed 创建失败 Created 创建完成 Deleting 删除中 DeletedFailed 删除失败 Deleted 已删除 NotFound 未发现操作 ) 示例值：Creating
ErrorMsg	String	操作失败的原因示例值：create failed
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

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

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

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	参数错误。
InternalError.UnexceptedInternal	内部错误。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter	参数错误。
InvalidParameter.AsCommonError	弹性伸缩组创建参数错误。
InvalidParameter.Param	参数错误。
OperationDenied	操作被拒绝。
ResourceInUse	资源被占用。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
UnsupportedOperation	操作不支持。

查询托管集群开启外网端口流程状态

本页目录：