DbLifeCycleManagementClient¶

class oci.dblm.DbLifeCycleManagementClient(config, **kwargs)¶

A description of the Dblm API

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_vulnerability_scan`(…)	Creates a VulnerabilityScan.
`get_vulnerability`(compartment_id, **kwargs)	Gets a Vulnerability
`get_vulnerability_scan`(…)	Gets information about a VulnerabilityScan.
`get_work_request`(work_request_id, **kwargs)	Gets details of the work request with the given ID.
`list_aggregated_vulnerability_data`(**kwargs)	Gets an AggregatedVulnerabilityData
`list_notifications`(compartment_id, **kwargs)	List of notifications
`list_vulnerabilities`(**kwargs)	Gets the vulnerabilities summary list
`list_vulnerability_resources`(compartment_id, …)	Lists the summary of vulnerable and clean resourcees
`list_vulnerability_scans`(**kwargs)	Gets a list of VulnerabilityScans.
`list_work_request_errors`(work_request_id, …)	Returns a (paginated) list of errors for the work request with the given ID.
`list_work_request_logs`(work_request_id, **kwargs)	Returns a (paginated) list of logs for the work request with the given ID.
`list_work_requests`(**kwargs)	Lists the work requests in a compartment.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

create_vulnerability_scan(create_vulnerability_scan_details, **kwargs)¶

Creates a VulnerabilityScan.

Parameters:	create_vulnerability_scan_details (oci.dblm.models.CreateVulnerabilityScanDetails) – (required) Details for the new VulnerabilityScan. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityScan`
Return type:	`Response`
Example:

Click here to see an example of how to use create_vulnerability_scan API.

get_vulnerability(compartment_id, **kwargs)¶

Gets a Vulnerability

Parameters:	compartment_id (str) – (required) The required ID of the compartment in which to list resources. opc_request_id (str) – (optional) The client request ID for tracing. database_release (str) – (optional) A filter to return only database that match the given release version. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DblmVulnerability`
Return type:	`Response`
Example:

Click here to see an example of how to use get_vulnerability API.

get_vulnerability_scan(vulnerability_scan_id, **kwargs)¶

Gets information about a VulnerabilityScan.

Parameters:	vulnerability_scan_id (str) – (required) The OCID of the VulnerabilityScan. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityScan`
Return type:	`Response`
Example:

Click here to see an example of how to use get_vulnerability_scan API.

get_work_request(work_request_id, **kwargs)¶

Gets details of the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

list_aggregated_vulnerability_data(**kwargs)¶

Gets an AggregatedVulnerabilityData

Parameters:	opc_request_id (str) – (optional) The client request ID for tracing. compartment_id (str) – (optional) The ID of the compartment in which to list resources. time_created_greater_than (datetime) – (optional) The created greater than. time_ended_less_than (datetime) – (optional) The time ended less than. database_release (str) – (optional) A filter to return only database that match the given release version. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AggregatedVulnerabilityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_aggregated_vulnerability_data API.

list_notifications(compartment_id, **kwargs)¶

List of notifications

Parameters:	compartment_id (str) – (required) The required ID of the compartment in which to list resources. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `NotificationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_notifications API.

list_vulnerabilities(**kwargs)¶

Gets the vulnerabilities summary list

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. display_name (str) – (optional) A filter to return only resources that match the entire display name given. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for vulnerableResources is descending. Default order for cveId is descending. Allowed values are: “cveId”, “vulnerableResources” opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED” database_release (str) – (optional) A filter to return only database that match the given release version. resource_id (str) – (optional) A filter to return only resources that match the given resource id. severity_type (list[str]) – (optional) Filter by one or more severity types. Possible values are critical, high, medium, low, info. Allowed values are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “INFO” search_by (str) – (optional) The search input for filter cve id and cve description. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_vulnerabilities API.

list_vulnerability_resources(compartment_id, **kwargs)¶

Lists the summary of vulnerable and clean resourcees

Parameters:	compartment_id (str) – (required) The required ID of the compartment in which to list resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. Allowed values are: “timeCreated”, “displayName”, “vulnerabilityCount” display_name (str) – (optional) A filter to return only resources that match the entire display name given. lifecycle_state (str) – (optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “NEEDS_ATTENTION”, “DELETING”, “DELETED” database_release (str) – (optional) A filter to return only database that match the given release version. cve_id (str) – (optional) The id of a CVE. severity_type (list[str]) – (optional) Filter by one or more severity types. Possible values are critical, high, medium, low, info and none. Allowed values are: “CRITICAL”, “HIGH”, “MEDIUM”, “LOW”, “INFO”, “NONE” patch_recommendation (list[str]) – (optional) Filter by one or more severity types. Possible values are upToDate, patchAvailable Allowed values are: “upToDate”, “patchAvailable” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityResourceCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_vulnerability_resources API.

list_vulnerability_scans(**kwargs)¶

Gets a list of VulnerabilityScans.

Parameters:	vulnerability_scan_id (str) – (optional) The ID of the vulnerability scan. compartment_id (str) – (optional) The ID of the compartment in which to list resources. display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order is descending. Allowed values are: “id”, “displayName”, “timeCreated”, “timeEnded” opc_request_id (str) – (optional) The client request ID for tracing. time_created_greater_than (datetime) – (optional) The created greater than. time_ended_less_than (datetime) – (optional) The time ended less than. vulnerability_scan_status (list[str]) – (optional) Filter by one or more vulnerability scan status. Possible values are completed, running, completed with error, aborted. Allowed values are: “COMPLETED”, “ERROR”, “RUNNING”, “ABORTED” vulnerability_scan_type (str) – (optional) The scan type to use is ‘CVE’, ‘PATCH’ or ‘IMAGE_PATCH’. Allowed values are: “CVE”, “PATCH”, “IMAGE_PATCH” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `VulnerabilityScanCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_vulnerability_scans API.

list_work_request_errors(work_request_id, **kwargs)¶

Returns a (paginated) list of errors for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestErrorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Returns a (paginated) list of logs for the work request with the given ID.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. Allowed values are: “timestamp” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestLogEntryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(**kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (optional) The ID of the compartment in which to list resources. work_request_id (str) – (optional) The ID of the asynchronous work request. status (str) – (optional) A filter to return only resources their lifecycleState matches the given OperationStatus. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” resource_id (str) – (optional) The ID of the resource affected by the work request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response. limit (int) – (optional) The maximum number of items to return. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. Allowed values are: “timeAccepted” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequestSummaryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.