Create deployment resource. ## Request description To achieve low latency, it is recommended to select the corresponding service address according to the region where the resource is located. For details, see [service address](https://www.volcengine.com/docs/6461/1802289). * Request method: POST * Request address: https://cp.cn\-beijing.volcengineapi.com?Action=CreateDeployResource&Version=2023\-05\-01 ## Debugging [去调试](https://api.volcengine.com/api-explorer/debug?action=CreateDeployResource&serviceCode=cp&version=2023-05-01&groupName=) ## Request parameters |**Parameter** |**Type** |**Required** |**Sample value** |**Description** | |---|---|---|---|---| |Action |String |Yes |CreateDeployResource |The API name. The current API name is `CreateDeployResource`. | |Version |String |Yes |2023\-05\-01 |The API version. The current API version is `2023-05-01`. | |Name |String |Yes |production\-cluster |The name of the deployment resource, used to identify and distinguish different deployment resources. | |Source |String |Yes |VKE |Source of the deployment resource. Values:

* `VKE`: Volcano Engine container service cluster.

* `K8S`: Self\-built or third party Kubernetes cluster. | |VkeClusterId |String |No |cc5silumrsfekhkr\*\*\*\* |When the source of the deployment resource is `VKE`, you need to specify the corresponding Volcano Engine container service cluster ID. Default value is an empty string. | |Kubeconfig |String |No |YXBpVmVyc\*\*\*\*Tl2ZENKOS4= |When the source of the deployment resource is `K8S`, you need to specify the base64\-encoded Kubeconfig information for the deployment resource. | |Region Code |String |No |cn\-beijing |The region to which the cluster corresponding to the deployment resource belongs. | |Description |String |No |Kubernetes cluster deployment resource for production environment |Description of the deployment resource, used to explain the purpose or feature of the resource. | |OnlyForSpecifiedWorkspaces |Boolean |No |false |Indicates whether the deployment resource is open only to specified workspaces. Valid values:

* true: Indicates that it is open only to specified workspaces. You need to specify the list of workspace IDs allowed to access using the SpecifiedWorkspaceIds parameter.

* false: (Default value) Indicates that it is open to all workspaces. | |SpecifiedWorkspaceIds |Array of String |No |["18be9\*\*\*\*\*a1aca409f5e19c\*\*\*\*"] |When `OnlyForSpecifiedWorkspaces` is `true`, you need to specify the list of workspace IDs allowed to access the deployment resource. | |Identifier |String |No |deploy\-resource\-123 |The unique identifier of the deployment resource, used to uniquely identify the resource in the system. | ## Sample requests ```JSON POST https://cp.cn-beijing.volcengineapi.com?Action=CreateDeployResource&Version=2023-05-01 HTTP/1.1 Content-Type: application/json { "Name": "production-cluster", "Source": "VKE", "VkeClusterId": "cc5silumrsfekhkr****", "Kubeconfig": "YXBpVmVyc****Tl2ZENKOS4=", "Region": "cn-beijing", "Description": "Kubernetes cluster deployment resource for production environment", "OnlyForSpecifiedWorkspaces": true, "SpecifiedWorkspaceIds": [ "18be9*****a1aca409f5e19c****" ], "Identifier": "deploy-resource-123" } ``` ## Response parameters |**Parameter** |**Type** |**Sample value** |**Description** | |---|---|---|---| |Id |String |18be9\*\*\*\*\*a1aca409f5e19c\*\*\*\* |The unique identifier ID of the deployment resource, used to identify the created deployment resource. | ## Sample responses ```JSON HTTP/1.1 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****10023228002****", "Action": "CreateDeployResource", "Version": "2023-05-01", "Service": "cp", "Region": "cn-beijing" }, "Result": { "Id": "18be9*****a1aca409f5e19c****" } } ``` ## Error code This interface currently does not have independent error codes. If the interface call returns an abnormal result, refer to [public error code](https://www.volcengine.com/docs/6461/1271177) for troubleshooting.

Code Pipeline