Search Domains

Request URL

POST {base_url}/uc-user/api/v1/domains/search-page

Request parameters

Headers

Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer {access_token}.

Body parameters

Parameter	Required	Type	Description
pageSize	Yes	Integer	The number of records to retrieve per page.
pageNumber	Yes	Integer	The page number to retrieve.
sorts	No	Array<Sort_Condition>	The sort conditions.
keyword	No	String	The keyword used to search for domain.
regionCode	No	String	The region code associated with the domain to search. Note: You can query the region code using Get Available Regions.
domainStatus	No	String	The status of the domain. Valid value: ACTIVE: The domain is active. DISABLED: The domain is disabled.
certificateStatus	No	String	The deployment status of the certificate. Valid value: NOT_DEPLOYED: The certificate is not deployed. PENDING: The certificate is being deployed. DEPLOYED: The certificate is deployed. FAILED: The certificate deployment failed. EXPIRED: The certificate is expired.
certificateManagement	No	String	The certificate management method. Valid value: AUTO: The certificate is managed automatically by the platform. CUSTOM: The certificate is uploaded by the user.
domain	No	String	The keyword used to search for domain.
expireTimeStart	No	Integer	The timestamp in milliseconds used to search for domains expiring after the specified time.
expireTimeEnd	No	Integer	The timestamp in milliseconds used to search for domains expiring before the specified time.
orderBy	No	String	The field to sort by. Valid value: createTime expireTime certificateStatus
orderDirection	No	String	The sort order. Valid value: asc: Sort in ascending order. desc: Sort in descending order.

Sort_Condition

Parameter	Required	Type	Description
direction	No	String	The sort order. Valid value: asc: Sort in ascending order. desc: Sort in descending order.
property	No	String	The name of the field to sort by. expireTime

Response parameters

Search_Result

Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
total	Integer	The total number of domains that match the search conditions.
results	Array<Domain_Item>	The list of domains.
totalPages	Integer	The total number of pages.
empty	Boolean	Whether the search result is empty. true: No domain matches the search conditions. false: At least one domain matches the search conditions.

Domain_Item

Parameter	Type	Description
id	String	The domain ID.
domain	String	The domain name.
regionCode	String	The region code.
regionName	String	The region name.
domainStatus	String	The status of the domain. ACTIVE: The domain is active. DISABLED: The domain is disabled.
certificateManagement	String	The certificate management method. AUTO: The certificate is managed automatically by the platform. CUSTOM: The certificate is uploaded by the user.
autoRenewEnabled	Boolean	Whether automatic certificate renewal is enabled. true: Enabled. false: Disabled.
certificateStatus	String	The deployment status of the certificate. NOT_DEPLOYED: The certificate is not deployed. PENDING: The certificate is being deployed. DEPLOYED: The certificate is deployed. FAILED: The certificate deployment failed. EXPIRED: The certificate is expired.
expireTime	Integer	The time when the certificate expires, in Unix timestamp format (milliseconds).
sourceType	String	The source type of the domain. USER_CONFIGURED: The domain is configured by the user. BYOI_DEPLOYMENT: The domain is deployed by BYOI.
createTime	Integer	The time when the domain was created, in Unix timestamp format (milliseconds).
effectiveDomain	String	The effective domain, which is computed at runtime.
effectiveDomainSource	String	The source of the effective domain. SELF: The effective domain is the domain itself. PARENT: The effective domain is inherited from the parent. OFFICIAL: The effective domain is the official domain.

Example

Request example

POST /uc-user/api/v1/domains/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTg4MDQwMCwiaWF0IjoxNzkxODU4ODAwLCJqdGkiOiJlYjczYTljNi05NGY1LTQ5MzItODcyYi0yMDUzMzVmMWE4YTkiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.hTHYgOuTSUnTMWM4NwMB6tPaChCUx2_2SNsSGTpGbIVF1goAOeUi1rbPej1t04EgzC_c6lfRAdf2mB0Uq4JP49DNYKDwbUDerQqc8WeO-RQvd466YJWsGlCJcWEzGaTXPpNG9glzn3i_zArhJN7MyzVKWz5ygKAadH7nQ5RJzLM6sOFnZ5DbTnQ4_uT_P-AdnPcTrlNvP62R58fiKjARMHPR0tHuUA3U0IiMKzH3uRVTyRXY_LccFFVys3Io5J5-ovntsTKaZ0o08kcXh1FJ5BW2Zj_6DJE_-Q1dwzQDkJ7aWJuRNSG30zXakHbuG7UqqFYRG8Y6MUDMoraKaCATKA
Content-Type: application/json
{
  "pageSize": 20,
  "pageNumber": 1
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "total": 1,
    "results": [
      {
        "id": "2089269871530487810",
        "domain": "novoone.online",
        "regionCode": "cn-0",
        "regionName": "HongKong",
        "domainStatus": "ACTIVE",
        "certificateManagement": "AUTO",
        "autoRenewEnabled": true,
        "certificateStatus": "DEPLOYED",
        "expireTime": 1794728675000,
        "sourceType": "USER_CONFIGURED",
        "createTime": 1786955728815,
        "effectiveDomain": "novoone.online",
        "effectiveDomainSource": "SELF"
      }
    ],
    "totalPages": 1,
    "empty": false
  },
  "requestId": "6bfbd2eab7e9eec0b7a4d89c56b51e1f",
  "code": "200",
  "message": "SUCCESS"
}