All Products
Search
Document Center

Web Application Firewall:CreateSM2Cert

Last Updated:Sep 13, 2024

Uploads a ShangMi (SM) certificate for a domain name that is added to Web Application Firewall (WAF) in CNAME record mode.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:CreateSM2Certcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CertNamestringNo

The name of the SM certificate.

test-sm2
EncryptCertificatestringNo

The content of the SM certificate.

-----BEGIN CERTIFICATE----- *** -----END CERTIFICATE-----
EncryptPrivateKeystringNo

The private key of the SM certificate.

-----BEGIN PRIVATE KEY----- *** -----END PRIVATE KEY-----
SignCertificatestringNo

The content of the signing certificate for the SM certificate.

-----BEGIN CERTIFICATE----- *** -----END CERTIFICATE-----
SignPrivateKeystringNo

The private key of the signing certificate for the SM certificate.

-----BEGIN PRIVATE KEY----- *** -----END PRIVATE KEY-----
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou
InstanceIdstringNo

The ID of the WAF instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf_v2_public_cn-***
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D7861F61-5B61-46CE-A47C-***
CertIdentifierstring

The ID of the certificate.

***-cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-***",
  "CertIdentifier": "***-cn-hangzhou"
}

Error codes

For a list of error codes, visit the Service error codes.