Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Secret/ Associating a Secret Registered by the Tenant
Updated on 2025-02-14 GMT+08:00

Associating a Secret Registered by the Tenant

Function

This API is used to associate a secret registered by the tenant.

URI

POST /v1/{project_id}/cae/dew-secrets

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Maximum characters: 16,384

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.
  • Enter 0 or up to 36 characters in UUID format with hyphens (-).
  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.
NOTE:

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

kind

Yes

String

Resource kind.

spec

Yes

CreateOrUpdateSecretDetail object

  
Table 4 CreateOrUpdateSecretDetail

Parameter

Mandatory

Type

Description

name

Yes

String

Secret name.

version_id

Yes

String

Current secret version number.

modified_time

Yes

Integer

Time when the current secret was created in DEW.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

kind

String

Resource kind.

spec

SecretDetail object

  
Table 6 SecretDetail

Parameter

Type

Description

id

String

Secret ID.

name

String

Secret name.

if_update_available

Boolean

Whether the current secret has a later version.

secret_status

String

Secret status in DEW.

status

String

Secret usage status in CAE.

version_id

String

Current secret version number.

modified_time

Integer

Time when the current secret was created in DEW.

Example Request

Create a secret.

Post https://{endpoint}/v1/{project_id}/cae/dew-secrets

Example Response

None

Status Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.