export_status
Creates, updates, deletes, gets or lists an export_status
resource.
Overview
Name | export_status |
Type | Resource |
Id | sumologic.content.export_status |
Fields
The following fields are returned by SELECT
queries:
- getAsyncExportStatus
The status of the export job.
Name | Datatype | Description |
---|---|---|
error | object | |
status | string | Whether or not the request is in progress (InProgress ), has completed successfully (Success ), or has completed with an error (Failed ). |
statusMessage | string | Additional status message generated if the status is not Failed . |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
getAsyncExportStatus | select | contentId , jobId , region | isAdminMode | Get the status of an asynchronous content export request for the given job identifier. On success, use the [getExportResult] endpoint to get the result of the export job. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
contentId | string | The identifier of the exported content item. |
jobId | string | The identifier of the asynchronous export job. |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
isAdminMode | string | Set this to "true" if you want to perform the request as a Content Administrator. |
SELECT
examples
- getAsyncExportStatus
Get the status of an asynchronous content export request for the given job identifier. On success, use the [getExportResult] endpoint to get the result of the export job.
SELECT
error,
status,
statusMessage
FROM sumologic.content.export_status
WHERE contentId = '{{ contentId }}' -- required
AND jobId = '{{ jobId }}' -- required
AND region = '{{ region }}' -- required
AND isAdminMode = '{{ isAdminMode }}'
;