get
/services/{version}/exttrails
必要なロール: ユーザー
デプロイメントのExtractとトレイル・ファイルのリスト取得リクエスト
パス・パラメータ
- version(必須): string
Oracle GoldenGateサービスのAPIバージョン。
指定できる値:[ "v2" ]
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
本文()
ルート・スキーマ: Oracle GoldenGate List of extracts and their trail files
型:
objectタイトル:
ソースの表示
Oracle GoldenGate List of extracts and their trail files- $schema:
指定できる値:
[ "ogg:extractTrailsList" ] - extracts(必須): array extracts
最小アイテム数:
0最大アイテム数:32767Extractとそのトレイル・ファイル情報のリスト
{
"title":"Oracle GoldenGate List of extracts and their trail files",
"required":[
"extracts"
],
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:extractTrailsList"
]
},
"extracts":{
"description":"List of extracts and their trail files info",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:extractTrails"
]
},
"name":{
"description":"Name of the extract",
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
"isRunning":{
"description":"Name of the extract",
"type":"boolean",
"default":false
},
"trails":{
"description":"List of trail files for this extract",
"type":"array",
"items":{
"type":"object",
"properties":{
"spaceUsed":{
"description":"Bytes consumed by all trail sequences",
"type":"integer",
"minimum":"0",
"maximum":"18446744073709552000"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":"500",
"minimum":"1",
"maximum":"2000"
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":"0",
"maximum":"2147483647"
},
"sequenceMaxInUse":{
"description":"Maximum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"trailName":{
"description":"The optional 'user-friendly' name for the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"3",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"remote":{
"description":"Indicates if trail is local or remote",
"type":"boolean",
"default":false
},
"sequenceLastArchived":{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
},
"name":{
"description":"The two-character name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":"2",
"maxLength":"2"
},
"sequence":{
"description":"Trail beginning sequence number",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"$schema":{
"enum":[
"ogg:trail"
]
},
"sequenceMinInUse":{
"description":"Minimum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLength":{
"description":"Number of digits in sequence file name",
"enum":[
"6",
"9"
],
"default":"9"
},
"sequenceMin":{
"description":"Minimum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLengthFlip":{
"description":"Indicates sequence number length will change",
"type":"boolean",
"default":false
},
"processRef":{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
},
"sequenceMax":{
"description":"Maximum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"description":{
"description":"Description for the trail",
"type":"string",
"minLength":"1",
"maxLength":"4095"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}
},
"required":[
"name",
"trails"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}
},
"additionalProperties":false
}ネストされたスキーマ: extracts
型:
array最小アイテム数:
0最大アイテム数:
32767Extractとそのトレイル・ファイル情報のリスト
ソースの表示
{
"description":"List of extracts and their trail files info",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:extractTrails"
]
},
"name":{
"description":"Name of the extract",
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
"isRunning":{
"description":"Name of the extract",
"type":"boolean",
"default":false
},
"trails":{
"description":"List of trail files for this extract",
"type":"array",
"items":{
"type":"object",
"properties":{
"spaceUsed":{
"description":"Bytes consumed by all trail sequences",
"type":"integer",
"minimum":"0",
"maximum":"18446744073709552000"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":"500",
"minimum":"1",
"maximum":"2000"
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":"0",
"maximum":"2147483647"
},
"sequenceMaxInUse":{
"description":"Maximum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"trailName":{
"description":"The optional 'user-friendly' name for the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"3",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"remote":{
"description":"Indicates if trail is local or remote",
"type":"boolean",
"default":false
},
"sequenceLastArchived":{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
},
"name":{
"description":"The two-character name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":"2",
"maxLength":"2"
},
"sequence":{
"description":"Trail beginning sequence number",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"$schema":{
"enum":[
"ogg:trail"
]
},
"sequenceMinInUse":{
"description":"Minimum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLength":{
"description":"Number of digits in sequence file name",
"enum":[
"6",
"9"
],
"default":"9"
},
"sequenceMin":{
"description":"Minimum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLengthFlip":{
"description":"Indicates sequence number length will change",
"type":"boolean",
"default":false
},
"processRef":{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
},
"sequenceMax":{
"description":"Maximum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"description":{
"description":"Description for the trail",
"type":"string",
"minLength":"1",
"maxLength":"4095"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}
},
"required":[
"name",
"trails"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}ネストされたスキーマ: items
型:
ソースの表示
object- $schema:
指定できる値:
[ "ogg:extractTrails" ] - isRunning: boolean
デフォルト値:
falseExtractの名前 - name(必須): string
最小長:
1最大長:8パターン:^[A-Z_$][A-Z0-9_$]*$Extractの名前 - trails(必須): array trails
最小アイテム数:
0最大アイテム数:32767このExtractのトレイル・ファイルのリスト
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:extractTrails"
]
},
"name":{
"description":"Name of the extract",
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
"isRunning":{
"description":"Name of the extract",
"type":"boolean",
"default":false
},
"trails":{
"description":"List of trail files for this extract",
"type":"array",
"items":{
"type":"object",
"properties":{
"spaceUsed":{
"description":"Bytes consumed by all trail sequences",
"type":"integer",
"minimum":"0",
"maximum":"18446744073709552000"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":"500",
"minimum":"1",
"maximum":"2000"
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":"0",
"maximum":"2147483647"
},
"sequenceMaxInUse":{
"description":"Maximum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"trailName":{
"description":"The optional 'user-friendly' name for the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"3",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"remote":{
"description":"Indicates if trail is local or remote",
"type":"boolean",
"default":false
},
"sequenceLastArchived":{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
},
"name":{
"description":"The two-character name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":"2",
"maxLength":"2"
},
"sequence":{
"description":"Trail beginning sequence number",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"$schema":{
"enum":[
"ogg:trail"
]
},
"sequenceMinInUse":{
"description":"Minimum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLength":{
"description":"Number of digits in sequence file name",
"enum":[
"6",
"9"
],
"default":"9"
},
"sequenceMin":{
"description":"Minimum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLengthFlip":{
"description":"Indicates sequence number length will change",
"type":"boolean",
"default":false
},
"processRef":{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
},
"sequenceMax":{
"description":"Maximum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"description":{
"description":"Description for the trail",
"type":"string",
"minLength":"1",
"maxLength":"4095"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}
},
"required":[
"name",
"trails"
],
"additionalProperties":false
}ネストされたスキーマ: trails
型:
array最小アイテム数:
0最大アイテム数:
32767このExtractのトレイル・ファイルのリスト
ソースの表示
{
"description":"List of trail files for this extract",
"type":"array",
"items":{
"type":"object",
"properties":{
"spaceUsed":{
"description":"Bytes consumed by all trail sequences",
"type":"integer",
"minimum":"0",
"maximum":"18446744073709552000"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":"500",
"minimum":"1",
"maximum":"2000"
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":"0",
"maximum":"2147483647"
},
"sequenceMaxInUse":{
"description":"Maximum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"trailName":{
"description":"The optional 'user-friendly' name for the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"3",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"remote":{
"description":"Indicates if trail is local or remote",
"type":"boolean",
"default":false
},
"sequenceLastArchived":{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
},
"name":{
"description":"The two-character name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":"2",
"maxLength":"2"
},
"sequence":{
"description":"Trail beginning sequence number",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"$schema":{
"enum":[
"ogg:trail"
]
},
"sequenceMinInUse":{
"description":"Minimum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLength":{
"description":"Number of digits in sequence file name",
"enum":[
"6",
"9"
],
"default":"9"
},
"sequenceMin":{
"description":"Minimum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLengthFlip":{
"description":"Indicates sequence number length will change",
"type":"boolean",
"default":false
},
"processRef":{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
},
"sequenceMax":{
"description":"Maximum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"description":{
"description":"Description for the trail",
"type":"string",
"minLength":"1",
"maxLength":"4095"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"32767"
}ネストされたスキーマ: items
型:
ソースの表示
object- $schema:
指定できる値:
[ "ogg:trail" ] - description: string
最小長:
1最大長:4095トレイルの説明 - name: string
最小長:
2最大長:2パターン:^[A-Za-z][A-Za-z0-9]$トレイルの2文字の名前 - offset: integer
最小値:
0最大値:2147483647トレイル順序ファイルのオフセット - path: string
最小長:
1最大長:4096トレイル・データが格納されるパス - processRef: array processRef
最小アイテム数:
1最大アイテム数:5000このトレイルに関連付けられているすべてのプロセスのリスト - remote: boolean
デフォルト値:
falseトレイルがローカルかリモートかを示します - sequence: integer
最小値:
0最大値:999999999デフォルト値:0トレイルの開始順序番号 - sequenceLastArchived: array sequenceLastArchived
最小アイテム数:
1最大アイテム数:128アーカイブされた最後の順序番号(管理対象トレイルのみ) - sequenceLength:
デフォルト値:
9指定できる値:[ "6", "9" ]順序ファイル名の字数 - sequenceLengthFlip: boolean
デフォルト値:
false順序番号の長さが変化することを示します - sequenceMax: integer
最小値:
0最大値:999999999デフォルト値:0デプロイメントに存在する最大のトレイル順序番号 - sequenceMaxInUse: integer
最小値:
0最大値:999999999デフォルト値:0使用されている最大のトレイル順序番号 - sequenceMin: integer
最小値:
0最大値:999999999デフォルト値:0デプロイメントに存在する最小のトレイル順序番号 - sequenceMinInUse: integer
最小値:
0最大値:999999999デフォルト値:0使用されている最小のトレイル順序番号 - sizeMB: integer
最小値:
1最大値:2000デフォルト値:500トレイル内のファイルの最大サイズ(MB)。 - spaceUsed: integer
最小値:
0最大値:18446744073709552000すべてのトレイル順序によって消費されたバイト数 - trailName: string
最小長:
3最大長:512パターン:^[a-zA-Z0-9_#$/-]*$トレイルのオプションのわかりやすい名前
{
"type":"object",
"properties":{
"spaceUsed":{
"description":"Bytes consumed by all trail sequences",
"type":"integer",
"minimum":"0",
"maximum":"18446744073709552000"
},
"sizeMB":{
"description":"The maximum size, in megabytes, of a file in the trail.",
"type":"integer",
"default":"500",
"minimum":"1",
"maximum":"2000"
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":"0",
"maximum":"2147483647"
},
"sequenceMaxInUse":{
"description":"Maximum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"trailName":{
"description":"The optional 'user-friendly' name for the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"3",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"remote":{
"description":"Indicates if trail is local or remote",
"type":"boolean",
"default":false
},
"sequenceLastArchived":{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
},
"name":{
"description":"The two-character name of the trail",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9]$",
"minLength":"2",
"maxLength":"2"
},
"sequence":{
"description":"Trail beginning sequence number",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"$schema":{
"enum":[
"ogg:trail"
]
},
"sequenceMinInUse":{
"description":"Minimum trail sequence number in use",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLength":{
"description":"Number of digits in sequence file name",
"enum":[
"6",
"9"
],
"default":"9"
},
"sequenceMin":{
"description":"Minimum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"sequenceLengthFlip":{
"description":"Indicates sequence number length will change",
"type":"boolean",
"default":false
},
"processRef":{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
},
"sequenceMax":{
"description":"Maximum trail sequence number that exists in the deployment",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
},
"description":{
"description":"Description for the trail",
"type":"string",
"minLength":"1",
"maxLength":"4095"
}
},
"additionalProperties":false
}ネストされたスキーマ: processRef
型:
array最小アイテム数:
1最大アイテム数:
5000このトレイルに関連付けられているすべてのプロセスのリスト
ソースの表示
- 配列: object items
この管理対象トレイルに関連付けられているOGGプロセスへの参照
{
"description":"List of all processes associated with this trail",
"type":"array",
"items":{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"5000"
}ネストされたスキーマ: sequenceLastArchived
型:
array最小アイテム数:
1最大アイテム数:
128アーカイブされた最後の順序番号(管理対象トレイルのみ)
ソースの表示
{
"description":"Last sequence number archived (Managed Trails only)",
"type":"array",
"items":{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"128"
}ネストされたスキーマ: items
型:
objectこの管理対象トレイルに関連付けられているOGGプロセスへの参照
ソースの表示
- processName(必須): processName
- processType(必須):
指定できる値:
[ "extract", "replicat", "distpath", "recvpath" ]
{
"description":"A reference to an OGG process associated with this managed trail",
"type":"object",
"properties":{
"processType":{
"enum":[
"extract",
"replicat",
"distpath",
"recvpath"
]
},
"processName":{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}
},
"required":[
"processType",
"processName"
],
"additionalProperties":false
}ネストされたスキーマ: processName
いずれかに一致
ソースの表示
- string
最小長:
1最大長:8パターン:^[A-Z_$][A-Z0-9_$]*$ - string
最小長:
1最大長:32パターン:^[A-Za-z][A-Za-z0-9-_.]*$
{
"x-anyOf":[
{
"type":"string",
"pattern":"^[A-Z_$][A-Z0-9_$]*$",
"minLength":"1",
"maxLength":"8"
},
{
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":"1",
"maxLength":"32"
}
]
}ネストされたスキーマ: items
型:
ソースの表示
object- archiveTarget(必須): archiveTarget
トレイル順序がアーカイブされた場所
- sequence(必須): integer
最小値:
0最大値:999999999デフォルト値:0関連タスクによってアーカイブされた最後の順序番号 - taskName: string
最小長:
1最大長:64パターン:^[A-Za-z0-9][A-Za-z0-9_-]*$トレイル順序をアーカイブしたタスクの名前
{
"type":"object",
"properties":{
"taskName":{
"description":"The name of the task which archived trail sequences",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$",
"minLength":"1",
"maxLength":"64"
},
"archiveTarget":{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
},
"sequence":{
"description":"Last sequence number archived by the associated task",
"type":"integer",
"minimum":"0",
"maximum":"999999999",
"default":"0"
}
},
"required":[
"archiveTarget",
"sequence"
],
"additionalProperties":false
}ネストされたスキーマ: archiveTarget
トレイル順序がアーカイブされた場所
1つに一致
ソースの表示
- string
最小長:
1最大長:4096トレイル順序が格納されるファイルシステム・ディレクトリ - object archiveTarget-x-oneOf[1]
OCIオブジェクト・ストレージ・バケット
- object archiveTarget-x-oneOf[2]
S3互換のオブジェクト・ストレージ・バケット
{
"description":"The location where the trail sequences were archived",
"x-oneOf":[
{
"description":"Filesystem directory where trail sequences are stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
},
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}
]
}ネストされたスキーマ: archiveTarget-x-oneOf[1]
型:
objectOCIオブジェクト・ストレージ・バケット
ソースの表示
- authentication(必須): authentication
- bucketName(必須): string
最小長:
1最大長:1024オブジェクト・ストレージ・バケットの名前 - nameSpace(必須): string
最小長:
1最大長:256OCIオブジェクト・ストレージ・ネームスペース
{
"description":"OCI Object Storage Bucket",
"type":"object",
"properties":{
"nameSpace":{
"description":"The OCI Object Storage namespace",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the Object Storage bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}
},
"required":[
"nameSpace",
"bucketName",
"authentication"
],
"additionalProperties":false
}ネストされたスキーマ: archiveTarget-x-oneOf[2]
型:
objectS3互換のオブジェクト・ストレージ・バケット
ソースの表示
- authentication: authentication
- bucketName(必須): string
最小長:
1最大長:1024S3互換バケットの名前 - region: string
最小長:
1最大長:256S3互換バケットのオプションのリージョン
{
"description":"S3-compatible object storage bucket",
"type":"object",
"properties":{
"region":{
"description":"The optional region for the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"bucketName":{
"description":"The name of the S3-compatible bucket",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"authentication":{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}
},
"required":[
"bucketName"
],
"additionalProperties":false
}ネストされたスキーマ: authentication
1つに一致
ソースの表示
- object authentication-x-oneOf[0]
デフォルトのプロファイル構成ファイルの名前付きプロファイルを使用した認証
- object authentication-x-oneOf[1]
インスタンス・プリンシパルを使用したOCIの認証
- object authentication-x-oneOf[2]
ユーザーのAPI署名キーを使用したOCIの認証
{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
},
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}
]
}ネストされたスキーマ: authentication-x-oneOf[0]
型:
objectデフォルトのプロファイル構成ファイルの名前付きプロファイルを使用した認証
ソースの表示
- profile(必須): string
最小長:
1最大長:256使用するプロファイルの名前
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
}ネストされたスキーマ: authentication-x-oneOf[1]
型:
objectインスタンス・プリンシパルを使用したOCIの認証
ソースの表示
- instancePrincipal(必須):
指定できる値:
[ true ]認証にインスタンス・プリンシパルを使用する必要があることを示します
{
"description":"Authentication for OCI using an instance principal",
"type":"object",
"properties":{
"instancePrincipal":{
"description":"Indicates the instance principal should be used for authentication",
"enum":[
true
]
}
},
"required":[
"instancePrincipal"
],
"additionalProperties":false
}ネストされたスキーマ: authentication-x-oneOf[2]
型:
objectユーザーのAPI署名キーを使用したOCIの認証
ソースの表示
- apiSigningKey(必須): string
最小長:
1最大長:10240パターン:^-----BEGIN RSA PRIVATE KEY----- ([A-Za-z0-9+/= ])+ -----END RSA PRIVATE KEY-----暗号化されていないAPI署名キー - apiSigningKeyFingerprint(必須): string
最小長:
47最大長:47パターン:^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$API署名キーのフィンガープリント - tenancyId(必須): string
最小長:
1最大長:256パターン:^ocid1[.]tenancy[.].*OCIテナンシOCID - userId(必須): string
最小長:
1最大長:256パターン:^ocid1[.]user[.].*OCIユーザーOCID
{
"description":"Authentication for OCI using an API signing key for a user",
"type":"object",
"properties":{
"tenancyId":{
"description":"OCI tenancy OCID",
"type":"string",
"pattern":"^ocid1[.]tenancy[.].*",
"minLength":"1",
"maxLength":"256"
},
"userId":{
"description":"OCI user OCID",
"type":"string",
"pattern":"^ocid1[.]user[.].*",
"minLength":"1",
"maxLength":"256"
},
"apiSigningKey":{
"description":"Unencrypted API signing key",
"type":"string",
"pattern":"^-----BEGIN RSA PRIVATE KEY-----\n([A-Za-z0-9+/=\n])+\n-----END RSA PRIVATE KEY-----",
"minLength":"1",
"maxLength":"10240"
},
"apiSigningKeyFingerprint":{
"description":"Fingerprint of the API signing key",
"type":"string",
"pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]){15}$",
"minLength":"47",
"maxLength":"47"
}
},
"required":[
"tenancyId",
"userId",
"apiSigningKey",
"apiSigningKeyFingerprint"
],
"additionalProperties":false
}ネストされたスキーマ: authentication
1つに一致
ソースの表示
- object authentication-x-oneOf[0]
デフォルトのプロファイル構成ファイルの名前付きプロファイルを使用した認証
- object authentication-x-oneOf[1]
シークレットを使用したS3の認証
{
"x-oneOf":[
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
},
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}
]
}ネストされたスキーマ: authentication-x-oneOf[0]
型:
objectデフォルトのプロファイル構成ファイルの名前付きプロファイルを使用した認証
ソースの表示
- profile(必須): string
最小長:
1最大長:256使用するプロファイルの名前
{
"description":"Authentication using a named profile from the default profile configuration file",
"type":"object",
"properties":{
"profile":{
"description":"Name of the profile to use",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"profile"
],
"additionalProperties":false
}ネストされたスキーマ: authentication-x-oneOf[1]
型:
objectシークレットを使用したS3の認証
ソースの表示
- accessKeyId(必須): string
最小長:
1最大長:256S3アクセス・キー - secretKey(必須): string
最小長:
1最大長:256S3シークレット・キー
{
"description":"S3 Authentication using secrets",
"type":"object",
"properties":{
"accessKeyId":{
"description":"S3 access key",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"secretKey":{
"description":"S3 secret key",
"type":"string",
"minLength":"1",
"maxLength":"256"
}
},
"required":[
"accessKeyId",
"secretKey"
],
"additionalProperties":false
}レスポンスの例(application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:9002/services/v2/exttrails",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:9002/services/v2/exttrails",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:extractTrailsList",
"extracts":[
{
"isRunning":true,
"name":"EXT1",
"trails":[
{
"name":"X1",
"offset":"1448",
"sequence":"1",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
}
]
},
{
"isRunning":true,
"name":"EXT2",
"trails":[
{
"name":"X2",
"offset":"1389",
"sequence":"0",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
}
]
},
{
"isRunning":true,
"name":"EXT3",
"trails":[
{
"name":"X3",
"offset":"1389",
"sequence":"0",
"sequenceLength":"9",
"sequenceLengthFlip":false,
"sizeMB":"500"
},
{
"name":"X4",
"offset":"0",
"sequence":"0",
"sequenceLength":"6",
"sequenceLengthFlip":true,
"sizeMB":"500"
},
{
"name":"X5",
"offset":"0",
"sequence":"0",
"sequenceLength":"6",
"sequenceLengthFlip":true,
"sizeMB":"500"
}
]
}
]
}
}