Querying a Certificate Passphrase

Updated on 2024-09-04 GMT+08:00

View PDF

This API is used to query the certificate passphrase of the secure transmission channel in a task.

For details, see Calling APIs.

GET /v3/tasks/{task_id}/passphrase

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
task_id	Yes	String	The task ID. Minimum length: 0 characters Maximum length: 255 characters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Minimum length: 1 character Maximum length: 16,384 characters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	The task ID. Minimum length: 0 characters Maximum length: 255 characters
passphrase	String	The passphrase of the secure transmission channel certificate. Minimum length: 0 characters Maximum length: 255 characters

This example queries the certificate passphrase of the secure transmission channel in task **d7fa81b9-c174-4c0a-a475-51a54c8af8a4**.

GET https://{endpoint}/v3/tasks/d7fa81b9-c174-4c0a-a475-51a54c8af8a4/passphrase

Status code: 200

This status code is returned when the request is successful.

{
  "task_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
  "passphrase" : "********"
}

Status Code	Description
200	This status code is returned when the request is successful.

For details, see Error Codes.

Parent topic: Task Management

Thank you very much for your feedback. We will continue working to improve the documentation.

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