Retrieves a list of certificate files.
Operation description
-
This API operation is available for all DataWorks editions.
-
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.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
The ID of the workspace to which the certificate file belongs. |
10000 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| PageNumber |
integer |
No |
The page number. Default value: 1. |
1 |
| Name |
string |
No |
The name of the certificate file. Fuzzy match by file name is supported. |
xm_create_test |
| CreateUser |
string |
No |
The ID of the user who created the certificate files. |
1107550004253538 |
| StartCreateTime |
integer |
No |
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 |
| EndCreateTime |
integer |
No |
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 |
| SortBy |
string |
No |
The field used to sort the certificate files. Valid values: CreateTime Id Name Default value: Id |
Id |
| Order |
string |
No |
The order in which you want to sort the certificate files. Valid values: Desc: descending order ASC: ascending order Default value: Asc |
Asc |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
ecb967ec-c137-48**** |
| PagingInfo |
object |
The pagination information. |
|
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalCount |
integer |
The total number of entries returned. |
100 |
| PageNumber |
integer |
The page number. |
1 |
| Certificates |
array<object> |
The certificate files. |
|
|
object |
The information about the certificate file. |
||
| Id |
integer |
The ID of the certificate file. |
676303114031776 |
| Name |
string |
The name of the certificate file. |
ca1.crt |
| CreateUser |
string |
The ID of the user who created the certificate file. |
1107550004253538 |
| CreateTime |
integer |
The time when the certificate file was created. This value is a UNIX timestamp. |
1730217600000 |
| FileSizeInBytes |
integer |
The size of the certificate file, in bytes. |
1024 |
| Description |
string |
The description. |
This is a file |
Examples
Success response
JSON format
{
"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
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.