Querying the Certificate Passphrase for a Migration Task's Secure Transmission Channel
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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
Yes |
String |
The task ID. Minimum length: 1 character Maximum length: 36 |
Request
|
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 |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
task_id |
String |
The task ID. Minimum length: 0 characters Maximum length: 255 characters |
|
passphrase |
String |
The certificate passphrase of the secure transmission channel. Minimum length: 0 characters Maximum length: 255 characters |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. Minimum length: 0 characters Maximum length: 255 characters |
|
error_msg |
String |
The error message. Minimum length: 0 characters Maximum length: 255 characters |
|
encoded_authorization_message |
String |
The encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters |
|
error_param |
Array of strings |
Invalid parameters. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20 |
|
details |
Array of details objects |
The error details. Array length: 1 to 20 |
Example Request
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 Response
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
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
