Updated on 2025-12-01 GMT+08:00

Enabling the GitOps Add-on

Function

This API is used to enable the GitOps add-on.

URI

POST /v1/clusters/{clusterid}/gitops

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

clusterid

Yes

String

Cluster ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

retry

No

String

Retry parameter

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

jobID

String

Job ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

-

String

-

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

-

String

-

Example Requests

Enabling GitOps for a specific cluster

POST https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}/gitops

Example Responses

Status code: 201

Job information for enabling GitOps returned

{
  "jobID" : "03e368ee-2647-41dd-958c-82ef3a38efe3"
}

Status Codes

Status Code

Description

201

Job information for enabling GitOps returned

400

Client request error. The server could not execute the request.

500

Internal server error

Error Codes

See Error Codes.