Help Center/ API Gateway/ API Reference/ Shared Gateway APIs (for Existing Users)/ Domain Name Management/ Object Model
Updated on 2022-09-01 GMT+08:00
View PDF
Share

Object Model

This section describes the object models for certificates and user-defined domain names.

  • Operation Type indicates the operation that can be performed on a field.

    C: create; U: update; R: read

  • Mandatory indicates whether a field with the Operation Type of C is mandatory.
Table 1 Domain name object model

Parameter

Type

Description

Operation Type

Mandatory

id

String

Domain ID

R

-

url_domain

String

Domain name

CR

Yes

cname_status

Integer

CNAME resolution status, which can be:

  • 1: not resolved
  • 2: in progress
  • 3: successful
  • 4: failed

R

No

ssl_id

String

Certificate ID

R

No

group_id

String

API group ID

CR

Yes
Table 2 Certificate object model

Parameter

Type

Description

Operation Type

Mandatory

id

String

Certificate ID

R

-

name

String

Certificate name

CRU

Yes

context

String

Content of the certificate

CRU

Yes

private_key

String

Private key of the certificate

CRU

Yes
Parent topic: Domain Name Management