Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Secrets/ Obtaining the Components That Are Using a Specific Secret
Updated on 2025-10-22 GMT+08:00

Obtaining the Components That Are Using a Specific Secret

Function

Obtain the components that are using a specific secret.

URI

GET /v1/{project_id}/cae/dew-secrets/{secret_id}/effective-components

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

secret_id

Yes

String

Secret ID.

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.

  • Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html).

  • The value of X-Subject-Token in the response header is the token value.

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 details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

kind

String

Resource kind.

items

Array of SecretDetail objects

Applications to which the scheduled start/stop policy applies. This parameter is mandatory only when effective_range is set to application.

Table 4 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.

  • normal

  • expired

  • deleted

status

String

Secret usage status in CAE.

  • used

  • free

version_id

String

Current secret version number.

modified_time

Integer

Time when the current secret was created in DEW.

Example Requests

Obtain the components that are using {secret-id}.

Get https://{endpoint}/v1/{project_id}/cae/dew-secrets/{secret_id}/effective-components

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.