All Products
Search
Document Center

DataWorks:ListCertificates

Last Updated:Jan 12, 2026

Queries a list of certificate files.

Operation description

  1. This API operation is available for all DataWorks editions.
  2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the workspace to which the certificate file belongs.

10000
PageSizeintegerNo

The number of entries per page. Default value: 10. Maximum value: 100.

10
PageNumberintegerNo

The page number. Default value: 1.

1
NamestringNo

The name of the certificate file. Fuzzy match by file name is supported.

xm_create_test
CreateUserstringNo

The ID of the user who created the certificate files.

1107550004253538
StartCreateTimelongNo

The time when the certificate file was created. You can call this operation to query the files that are created after the time. Unit: milliseconds.

1730217600000
EndCreateTimelongNo

The time when the certificate file was created. You can call this operation to query the files that are created before the time. Unit: milliseconds.

1593877765000
SortBystringNo

The field used to sort the certificate files. Valid values: CreateTime Id Name Default value: Id

Id
OrderstringNo

The order in which you want to sort the certificate files. Valid values: Desc: descending order ASC: ascending order Default value: Asc

Asc

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

ecb967ec-c137-48****
PagingInfoobject

The pagination information.

PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of entries returned.

100
PageNumberinteger

The page number.

1
Certificatesarray<object>

The certificate files.

object

The information about the certificate file.

Idlong

The ID of the certificate file.

676303114031776
Namestring

The name of the certificate file.

ca1.crt
CreateUserstring

The ID of the user who created the certificate file.

1107550004253538
CreateTimelong

The time when the certificate file was created. This value is a UNIX timestamp.

1730217600000
FileSizeInByteslong

The size of the certificate file, in bytes.

1024
Descriptionstring

The description.

This is a file

Examples

Sample success responses

JSONformat

{
  "RequestId": "ecb967ec-c137-48****",
  "PagingInfo": {
    "PageSize": 10,
    "TotalCount": 100,
    "PageNumber": 1,
    "Certificates": [
      {
        "Id": 676303114031776,
        "Name": "ca1.crt",
        "CreateUser": 1107550004253538,
        "CreateTime": 1730217600000,
        "FileSizeInBytes": 1024,
        "Description": "This is a file"
      }
    ]
  }
}

Error codes

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