apmsynthetics.oracle.com/v1beta1¶
APIVersion: apmsynthetics.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes apmsynthetics.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Script | Namespaced | Sample | - |
Script¶
Manage OCI Application Performance Monitoring synthetics scripts.
Plural:scriptsScope:NamespacedAPIVersion:apmsynthetics.oracle.com/v1beta1Sample: Sample (config/samples/apmsynthetics_v1beta1_script.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
ScriptSpec defines the desired state of Script.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
apmDomainId |
The APM Domain ID the request is intended for. | string |
Yes | - | - |
content |
The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: <ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : <ORAP><ON>param name</ON></ORAP> With parameter name and value : <ORAP><ON>param name</ON><OV>param value</OV></ORAP> Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format. |
string |
Yes | - | - |
contentFileName |
File name of uploaded script content. | string |
No | - | - |
contentType |
Content type of script. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
Unique name that can be edited. The name should not contain any confidential information. | string |
Yes | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
parameters |
List of script parameters. Example: [{"paramName": "userid", "paramValue":"testuser", "isSecret": false}] |
list[object] |
No | - | - |
Spec.parameters[]¶
ScriptParameter defines nested fields for Script.Parameter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isSecret |
If the parameter value is secret and should be kept confidential, then set isSecret to true. | boolean |
No | - | - |
paramName |
Name of the parameter. | string |
Yes | - | - |
paramValue |
Value of the parameter. | string |
No | - | - |
Status¶
ScriptStatus defines the observed state of Script.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
apmDomainId |
The bound APM Domain ID used to address this script. | string |
No | - | - |
contentFileName |
File name of the uploaded script content. | string |
No | - | - |
contentSizeInBytes |
Size of the script content. | integer |
No | - | - |
contentType |
Content type of the script. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
displayName |
Unique name that can be edited. The name should not contain any confidential information. | string |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. | string |
No | - | - |
monitorStatusCountMap |
ScriptMonitorStatusCountMap defines nested fields for Script.MonitorStatusCountMap. | object |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The time the resource was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2020-02-12T22:47:12.613Z |
string |
No | - | - |
timeUpdated |
The time the resource was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2020-02-13T22:47:12.613Z |
string |
No | - | - |
timeUploaded |
The time the script was uploaded. | string |
No | - | - |
Status.monitorStatusCountMap¶
ScriptMonitorStatusCountMap defines nested fields for Script.MonitorStatusCountMap.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
disabled |
Number of disabled monitors using the script. | integer |
No | - | - |
enabled |
Number of enabled monitors using the script. | integer |
No | - | - |
invalid |
Number of invalid monitors using the script. | integer |
No | - | - |
total |
Total number of monitors using the script. | integer |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |