Help Center/Server Migration Service/API Reference/API/Task Management/Querying a Certificate Passphrase
Updated on 2026-01-27 GMT+08:00
View PDF

Querying a Certificate Passphrase

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v3/tasks/{task_id}/passphrase

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID.

Minimum: 1

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_id

String

The task ID.

Minimum: 0

Maximum: 255

passphrase

String

The certificate passphrase of the secure transmission channel.

Minimum: 0

Maximum: 255

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

The error code.

Minimum: 0

Maximum: 255

error_msg

String

The error message.

Minimum: 0

Maximum: 255

encoded_authorization_message

String

The encrypted authorization information.

Minimum: 0

Maximum: 65535

error_param

Array of strings

Error parameters.

Minimum: 0

Maximum: 65535

Array Length: 1 - 20

details

Array of details objects

The error details.

Array Length: 1 - 20

Table 5 details

Parameter

Type

Description

error_code

String

The SMS error code.

Minimum: 0

Maximum: 65535

error_msg

String

The SMS error message.

Minimum: 0

Maximum: 65535

Example Requests

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

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

Example Responses

Status code: 200

Request succeeded.

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

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

403

Authentication failed.

Error Codes

See Error Codes.

Parent topic:Task Management