Activating a CA

Function

This API is used to activate a CA.

You can activate a certificate only when it is in the Pending activation status.

URI

POST /v1/private-certificate-authorities/{ca_id}/activate

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
ca_id	Yes	String	ID of the subordinate CA you want to activate. Minimum: 36 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 token API of IAM. The value of X-Auth-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
issuer_id	Yes	String	ID of the parent CA. Minimum: 1 Maximum: 64
path_length	Yes	Integer	Path length. Minimum: 0 Maximum: 6
signature_algorithm	Yes	String	Signature hash algorithm. The options are as follows: SHA256 SHA384 SHA512
validity	Yes	Validity object	Certificate validity. For details, see data structure for the Validity field.

**Table 4** Validity
Parameter	Mandatory	Type	Description
type	Yes	String	Validity period type, which is mandatory. The options are as follows: YEAR: Year (12 months) MONTH: Month (31 days) DAY: Day HOUR: Hour
value	Yes	Integer	The certificate validity period. The value of this parameter varies depending on the value of type: Root CA certificates: no longer than 30 years Subordinate CA or private certificates: no longer than 20 years
start_from	No	Integer	Start time. The options are as follows: The value is a timestamp in milliseconds. For example, 1645146939688 indicates 2022-02-18 09:15:39. The value of start_from cannot be earlier than the result of the value of current_time minus 5 minutes.

Response Parameters

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 3 Maximum: 36
error_msg	String	Error message Minimum: 0 Maximum: 1024

Example Requests

When you use this API to activate a CA certificate, a token is required in the X-Auth-Token field in the request header. The token must have the permission to access the API.

POST https://ccm.ae-ad-1.myhuaweicloud.com/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/activate

{
  "signature_algorithm" : "SHA256",
  "validity" : {
    "type" : "YEAR",
    "value" : 1
  },
  "path_length" : 3,
  "issuer_id" : "c718fe5f-d44a-467f-80f1-948348ff4132"
}

Example Responses

Status code: 400

Invalid request parameters.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 401

Token required for the requested page.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Authentication failed.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 404

No resources available or found.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Internal service error.

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code	Description
204	Request succeeded, but no response body returned.
400	Invalid request parameters.
401	Token required for the requested page.
403	Authentication failed.
404	No resources available or found.
500	Internal service error.