Obtaining an SSL Certificate and Private Key
Function
If the block-level migration method is used, the Agent installed on the source server communicates with the target server through an SSL socket. This API is used to download the certificate and private key (in PEM format) required for data migration.
Calling Method
For details, see Calling APIs.
Authorization
Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the permission listed below is required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
sms:server:getCert
Read
server *
-
- sms:server:queryServer
-
-
g:EnterpriseProjectId
URI
GET /v3/tasks/{task_id}/certkey
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
Yes |
String |
The migration task ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
enable_ca_cert |
No |
Boolean |
Indicates whether to generate a CA certificate. Default Value true |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
X-Auth-Token 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. |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
cert |
String |
The source certificate. |
|
private_key |
String |
The source private key. |
|
ca |
String |
The CA certificate. |
|
target_mgmt_cert |
String |
The certificate of the target server for migration task management. |
|
target_mgmt_private_key |
String |
The private key of the target server for migration task management. |
|
target_data_cert |
String |
The certificate of the target server for data migration. |
|
target_data_private_key |
String |
The private key of the target server for data migration. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
|
encoded_authorization_message |
String |
The encrypted authorization information. |
|
error_param |
Array of strings |
Invalid parameters. |
|
details |
Array of details objects |
The error details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The SMS error code. |
|
error_msg |
String |
The SMS error message. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Example Request
This example obtains the certificate and private key required for a migration task.
GET https://{endpoint}/v3/tasks/{task_id}/certkey?enable_ca_cert=true
Example Response
Status code: 200
Obtaining an SSL certificate and private key succeeded.
{
"ca" : "-----BEGIN CERTIFICATE-----\n********************************\n-----END CERTIFICATE-----",
"cert" : "-----BEGIN CERTIFICATE-----\n********************************\n-----END CERTIFICATE-----",
"private_key" : "-----BEGIN RSA PRIVATE KEY-----\n********************************\n-----END RSA PRIVATE KEY-----",
"target_mgmt_cert" : "-----BEGIN CERTIFICATE-----\n********************************\n-----END CERTIFICATE-----",
"target_mgmt_private_key" : "-----BEGIN RSA PRIVATE KEY-----\n********************************\n-----END RSA PRIVATE KEY-----",
"target_data_cert" : "-----BEGIN CERTIFICATE-----\n********************************\n-----END CERTIFICATE-----",
"target_data_private_key" : "-----BEGIN RSA PRIVATE KEY-----\n********************************\n-----END RSA PRIVATE KEY-----"
}
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."
} ]
}
SDK Sample Code
The sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class ShowCertKeySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("<YOUR REGION>")) .build(); ShowCertKeyRequest request = new ShowCertKeyRequest(); request.withTaskId("{task_id}"); try { ShowCertKeyResponse response = client.showCertKey(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowCertKeyRequest() request.task_id = "{task_id}" response = client.show_cert_key(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := sms.NewSmsClient( sms.SmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowCertKeyRequest{} request.TaskId = "{task_id}" response, err := client.ShowCertKey(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Obtaining an SSL certificate and private key succeeded. |
|
400 |
Bad request. |
|
401 |
Unauthorized. |
|
403 |
Authentication failed. |
|
404 |
Not found. |
|
500 |
Internal server error. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot