Help Center/ Cloud Application Engine/ API Reference/ CAE API/ Secret/ Obtaining the Components That Are Using a Specific Secret

Updated on 2025-02-14 GMT+08:00

View PDF

Obtaining the Components That Are Using a Specific Secret

This API is used to obtain the components that are using a specific secret.

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

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
secret_id	Yes	String	Secret ID.
project_id	Yes	String	Project ID. See Obtaining a Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. 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. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

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

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

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

None

Status Code	Description
200	The request is successful.

For details, see Error Codes.

Parent topic: Secret

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.