生成集群的 Kubeconfig 凭证。 ## 使用说明此接口为异步接口，当此接口返回成功时，不代表 Kubeconfig 立刻可以使用，需要您调用 [ListKubeconfigs](https://www.volcengine.com/docs/6460/163036) 接口，成功获取该 Kubeconfig 的文本信息并稍等 5 秒后尝试使用。 ## 请求说明 * 请求方式：POST * 请求地址：https://open.volcengineapi.com/?Action=CreateKubeconfig&Version=2022\-05\-12 ## 调试 ## 请求参数调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 [公共参数](https://www.volcengine.com/docs/6460/70904)。 |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |CreateKubeconfig |接口名称。当前 API 的名称为 `CreateKubeconfig`。 | |Version |String |是 |2022\-05\-12 |接口版本。当前 API 的版本为 `2022-05-12`。 | |ClusterId |String |是 |cc8oo0ivqt\*\*\*\*\*\*\*\* |集群 ID。|\ | | | | |可以调用 [ListClusters](https://www.volcengine.com/docs/6460/115190) 接口，获取集群 ID。|\ | | | | |:::warning|\ | | | | |集群必须处于`{Running,[Ok]}`或`{Updating,[Progressing]}`状态。可调用 [ListClusters](https://www.volcengine.com/docs/6460/115190) 接口获取集群当前的状态。|\ | | | | ||\ | | | | |:::| |Type |String |是 |Private |集群 Kubeconfig 文件类型，取值：|\ | | | | ||\ | | | | |* **Private**：私网访问类型的 Kubeconfig。|\ | | | | |* **Public**：公网访问类型的 Kubeconfig。 | |ValidDuration |Integer |否 |43800 |Kubeconfig 文件有效期。|\ | | | | ||\ | | | | |* 取值范围：1～867240。|\ | | | | |* 单位：小时。|\ | | | | |* 默认值：26280（3年）。 | ## 请求示例 ```json POST https://open.volcengineapi.com/?Action=CreateKubeconfig&Version=2022-05-12 Content-Type:application/json { "ClusterId": "cc8oo0ivqt********", "Type": "Private", "ValidDuration": 867240 } ``` ## 返回参数本接口返回参数如下表所示，公共返回参数请参见 [返回结果](https://www.volcengine.com/docs/6460/79674)。 |参数 |类型 |示例值 |描述 | |---|---|---|---| |Id |String |kc5silum\*\*\*\*\*\*\*\* |Kubeconfig ID。|\ | | | |:::warning|\ | | | |建议您妥善保存 Kubeconfig ID 信息，以备后续使用。|\ | | | ||\ | | | |:::| ## 返回示例 ```json HTTP/1.1 200 OK Content-Type:application/json { "ResponseMetadata": { "RequestId": "0216353********", "Action": "CreateKubeconfig", "Version": "2022-05-12", "Service": "vke", "Region": "cn-beijing" }, "Result": { "Id": "kc5silum********" } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6460/118978)。 |HTTP 状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |OperationDenied.ClusterStatus |The action has been denied due to wrong cluster status {{statusPhase}} and [{{statusConditions}}]. |指定集群的当前状态不支持该操作。请确认该接口依赖的集群状态后重试。 | |400 |LimitExceeded.KubeconfigNumber |You have reached the limit of the number of kubeconfig that you can create. |可生成的 Kubeconfig 文件数量已达到上限。产品限制说明，请参见 [使用限制](https://www.volcengine.com/docs/6460/79642)。 |

容器服务