Help Center/ Elastic Load Balance/ API Reference/ APIs (V3)/ Certificate/ Enabling or Disabling the Private Key Feature
Updated on 2025-09-22 GMT+08:00

Enabling or Disabling the Private Key Feature

Function

This API is used to enable or disable private_key_echo. private_key_echo defines whether to include private_key and enc_private_key in the response to each certificate API. If private_key_echo is set to true, the private key is returned when APIs are called to create a certificate, update a certificate, query the certificate details, and query the certificate list. If private_key_echo is set to false, the private key is anonymized as ****** and returned. The private_key_echo setting applies to the whole tenant project. It is enabled by default.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/elb/certificates/settings/private-key-echo

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

private_key_echo

Yes

Boolean

Definition: Specifies whether to set private_key_echo to true.

Constraints: N/A

Range:

  • true: The private key is displayed in the responses of the APIs for querying, adding, and updating a certificate, as well as the API for querying the certificate list.

  • false: The private key is not displayed in the responses of all certificate APIs, but anonymized as *****.

Default value: N/A

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Definition: Specifies the request ID.

Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-).

private_key_echo

Boolean

Definition: Specifies whether to set private_key_echo to true.

Range:

  • true: The private key is displayed in the responses of the APIs for querying, adding, and updating a certificate, as well as the API for querying the certificate list.

  • false: The private key is not displayed in the responses of all certificate APIs, but anonymized as *****.

Example Requests

Enabling or disabling the private key feature

POST https://{ELB_Endpoint}/v3/{project_id}/elb/certificates/settings/private-key-echo

{
  "private_key_echo" : true
}

Example Responses

Status code: 201

Successful request.

{
  "private_key_echo" : true,
  "request_id" : "98414965-856c-4be3-8a33-3e08432a222e"
}

SDK Sample Code

The SDK sample code is as follows.

Enabling or disabling the private key feature

 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
47
48
49
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.elb.v3.region.ElbRegion;
import com.huaweicloud.sdk.elb.v3.*;
import com.huaweicloud.sdk.elb.v3.model.*;


public class CreateCertificatePrivateKeyEchoSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        ElbClient client = ElbClient.newBuilder()
                .withCredential(auth)
                .withRegion(ElbRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateCertificatePrivateKeyEchoRequest request = new CreateCertificatePrivateKeyEchoRequest();
        CreateCertificatePrivateKeyEchoRequestBody body = new CreateCertificatePrivateKeyEchoRequestBody();
        body.withPrivateKeyEcho(true);
        request.withBody(body);
        try {
            CreateCertificatePrivateKeyEchoResponse response = client.createCertificatePrivateKeyEcho(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());
        }
    }
}

Enabling or disabling the private key feature

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkelb.v3.region.elb_region import ElbRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkelb.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = ElbClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ElbRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateCertificatePrivateKeyEchoRequest()
        request.body = CreateCertificatePrivateKeyEchoRequestBody(
            private_key_echo=True
        )
        response = client.create_certificate_private_key_echo(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Enabling or disabling the private key feature

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := elb.NewElbClient(
        elb.ElbClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateCertificatePrivateKeyEchoRequest{}
	request.Body = &model.CreateCertificatePrivateKeyEchoRequestBody{
		PrivateKeyEcho: true,
	}
	response, err := client.CreateCertificatePrivateKeyEcho(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

201

Successful request.

Error Codes

See Error Codes.