Help Center/ Cloud Certificate Manager/ API Reference/ Historical APIs/ SCM APIs/ Querying Details of a Certificate
Updated on 2022-08-09 GMT+08:00
View PDF

Querying Details of a Certificate

Function

This API is used to query details of a certificate.

This API will be discarded. You are advised to obtain certificate details by referring to Obtaining Details of a Certificate.

URI

  • URI format

    GET /v2/{project_id}/scm/cert/{cert_id}

  • Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

    cert_id

    Yes

    String

    Certificate ID.

Request

Request parameters

None

Response

Response parameters

Parameter

Mandatory

Type

Description

cert_id

Yes

String

Certificate ID.

order_id

Yes

String

Order ID.

cert_name

Yes

String

Certificate name.

cert_type

Yes

String

Certificate type.

Example: OV

cert_brand

Yes

String

Certificate brand.

Example: GLOBALSIGN

domain_type

Yes

String

Domain name type.

Example: MUILT_DOMAIN

domain_name

Yes

String

Domain name bound to a certificate.

Example: funnyzx.com;abc.com

domain_number

Yes

Integer

Number of domains.

Example: 3

cert_describe

Yes

String

Certificate description.

push_support

Yes

String

Whether a certificate can be pushed.

revoke_reason

Yes

String

Reason for certificate revocation.

domain_name

Yes

String

Domain name bound to a certificate. Multiple domain names are separated by semicolons (;).

Example: www.example.com;www.example1.com;www.example2.com

company_name

Yes

String

Company name.

company_province

Yes

String

State or region where a company is located.

company_city

Yes

String

City where a company is located.

applicant_name

Yes

String

Name of a company contact.

applicant_phone

Yes

String

Phone number of a company contact.

applicant_email

Yes

String

Email of a company contact.

contact_name

Yes

String

Name of a technical contact.

contact_phone

Yes

String

Phone number of a technical contact.

contact_email

Yes

String

Email of a technical contact.

status

Yes

String

Certificate status.

encrypt_type

Yes

String

Signature encryption algorithm.

country

Yes

String

Country code.

organization_unit

Yes

String

Company department.

DNS_push_status

Yes

String

DNS push status

  • ON: indicates that the push is successful.
  • OFF: indicates that the push fails.
  • NONE: indicates that the push function is not enabled.

auth

Yes

Array of auth objects

Certificate authentication status. For details, see Table 1.
Table 1 auth

Parameter

Mandatory

Type

Description

method

Yes

String

Authentication method.

status

Yes

String

Certificate authentication status.

domain_name

Yes

String

Domain name for DNS authentication.

host_record

Yes

String

Host record of DNS authentication.

record_type

Yes

String

Record type of DNS authentication.

record

Yes

String

Record value of DNS authentication.

Example

  • Example request

    None

  • Example response
    {
"cert_id": "scs1481110651012",
"order_id ": "CS1803192259ROA8U",
"cert_name": "test",
"cert_type": "OV",
"cert_brand": "GEOTRUST",
"domain_type": "MUILT_DOMAIN",
"domain_name": "funnyzx.com;abc.com",
"domain_number": 3,
"cert_describe": "XXXXXXXXX",
"push_support": "on",
"revoke_reason":"xxxxxxxxxxx",
"domain_name": " www.test.com;*.example1.com;*.example2.com",
"company_name": "Huawei Technologies Co., Ltd.",
"company_province": "Guangdong",
"company_city": "Shenzhen",
"applicant_name": "Tom",
"applicant_phone": "13087654321",
"applicant_email": "example@xx.com",
"contact_name": "Jacky",
"contact_phone": "13087654321",
"contact_email": "example@xx.com",
"status": "PAID",
"encrypt_type": "SHA256withRSA2048",
"country": "CN",
"organization_unit": "unit",
"DNS_push_status": "ON",
"auth": [{
"method": "DNS",
"status": " checking ",
"domain_name": "www.test.com",
"host_record": "dnsauth",
"record_type": "TXT",
"record": "201803272148qwedginciog08"
 }]
}

    or

    { 
   "error_code": "SCM.XXXX",  
   "error_msg": "XXXX"   
 }

Status Codes

Table 2 lists the normal status code returned by the API.
Table 2 Status code

Status Code

Status

Description

200

OK

Request processed successfully.

For details about error code, see Error Codes

Parent topic: SCM APIs