Help Center/ Cloud Container Engine/ API Reference/ APIs/ Cluster Management/ Updating the Global OBS Access Secret of a Cluster
Updated on 2025-07-10 GMT+08:00

Updating the Global OBS Access Secret of a Cluster

Function

This API is used to update the global OBS access secret of a cluster.

Calling Method

For details, see Calling APIs.

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/longaksk/config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

cluster_id

Yes

String

Details:

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Cluster IDs

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

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. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

enableLongAKSK

Yes

Boolean

Definition:

Whether to enable the global OBS access secret. If this option is enabled, the paas.longaksk secret will be created in the kube-system namespace of the cluster. If this option is disabled, the secret will be deleted.

Constraints:

N/A

Options:

  • false: The global OBS access secret is disabled.

  • true: The global OBS access secret is enabled.

Default value:

N/A

Response Parameters

Status code: 204

The global OBS access secret has been updated.

None

Example Requests

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/longaksk/config

{
  "enableLongAKSK" : true
}

Example Responses

None

Status Codes

Status Code

Description

204

The global OBS access secret has been updated.

Error Codes

See Error Codes.