Querying Custom Jobs

Function

This API is used to query custom jobs.

Constraints

Only the custom job list of the current account can be queried.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:document:listDocument	List	-	-	-	-

URI

GET /v1/documents

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Pagination parameter, which indicates the maximum number of records returned on each page. Constraints: N/A. Value range: N/A. Default value: N/A.
offset	No	String	Definition: Offset. Constraints: N/A. Value range: N/A. Default value: N/A.
name_like	No	String	Definition: Job name (fuzzy). Constraints: N/A. Value range: N/A. Default value: N/A.
creator	No	String	Definition: Creator. Constraints: N/A. Value range: N/A. Default value: N/A.
enterprise_project_id	No	String	Definition: Enterprise project ID. Constraints: N/A. Value range: N/A. Default value: N/A.
document_type	No	String	Definition: Type of the job to be executed. Constraints: Value: PUBLIC or NORMAL Default value: NORMAL Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

Custom jobs are successfully queried.

None

Example Requests

Query the custom job list.

GET https://{Endpoint}/v1/documents?offset=0&limit=2

Example Responses

Status code: 200

Custom jobs are successfully queried.

{
  "data" : [ {
    "document_id" : "DM2025063021170101xxxxx",
    "name" : "qweqwe",
    "create_time" : 1751289421846,
    "update_time" : 1751289421846,
    "version" : "v1",
    "creator" : "COC-xxxxx",
    "modifier" : null,
    "enterprise_project_id" : "0",
    "risk_level" : "HIGH"
  }, {
    "document_id" : "DM20250604143026019xxxxx",
    "name" : "cfm-job-new-0604001",
    "create_time" : 1749018626043,
    "update_time" : 1751075577067,
    "version" : "v3",
    "creator" : "COC-xxxxx",
    "modifier" : "COC-xxxxx",
    "enterprise_project_id" : "0",
    "risk_level" : "LOW"
  } ],
  "total" : 74
}