Get a stream

get

https://{hostname}/datastream-config-api/v2/log/streams/{streamId}

Returns information about any version of a stream, including details about the monitored properties, logged data set fields, and log delivery destination. If you omit the version query parameter, this operation returns the last version of the stream.

Response

Response body

object

collectMidgress

boolean

Indicates if you've opted to capture midgress traffic within the Akamai platform, such as between two edge servers.

contractId

string

required

Identifies the contract that the stream belongs to.

createdBy

string

required

The username who created the stream.

createdDate

date-time

required

An ISO 8601 timestamp marking when the stream was created.

datasetFields

array of objects

required

A list of data set fields selected that the stream monitors in logs. The order of the identifiers define how the value for these fields appear in the log lines.

datasetFields*

object

datasetFieldId

integer

required

Identifies the field.

datasetFieldJsonKey

string

required

Specifies the JSON key for the field in a log line. You can get this value only when you run the List data set fields or Get a stream operation for a stream in the JSON format.

datasetFieldName

string

required

A name of the data set field.

deliveryConfiguration

object

required

The configuration of log lines, names of the files sent to a destination, and delivery frequency for these files.

fieldDelimiter

string

enum

A delimiter that separates data set fields in the log lines, either SPACE or TAB. Set this only for the STRUCTURED log file format.

SPACE TAB

format

string

enum

required

The format in which you want to receive log files. STRUCTURED or JSON are the currently available formats.

STRUCTURED JSON

frequency

object

required

The frequency of collecting logs from each uploader and sending these logs to a destination.

uploadFilePrefix

string

Defaults to ak

The prefix of the log file that you want to send to a object-based destination. It's a string of at most 200 characters. This member supports Dynamic time variables. If unspecified, it defaults to ak.

uploadFileSuffix

string

Defaults to ds

The suffix of the log file that you want to send to a object-based destination. This member supports Dynamic time variables. It's a static string of at most 10 characters. If unspecified, it defaults to ds.

destination

required

Provides detailed information about the destination's configuration in the stream to send logs.

AZURE

DATADOG

SPLUNK

GCS

HTTPS

ORACLE_CLOUD_STORAGE

SUMO_LOGIC

LOGGLY

ELASTICSEARCH

NEWRELIC

S3_COMPATIBLE

groupId

integer

required

Identifies the group that has access to the product and that you created the stream configuration for. When editing a stream, the value you pass is ignored as you can't change the group for an existing stream.

latestVersion

integer

required

Identifies the latest configuration version of the stream.

modifiedBy

string

required

The username who modified the stream.

modifiedDate

date-time

required

The date and time in the ISO 8601 format when the stream was modified.

notificationEmails

array of strings

A comma-delimited list of email addresses where the system sends notifications about activations and deactivations of the stream.

notificationEmails

productId

string

required

The ID of the product that you created stream for.

properties

array of objects

required

Identifies the properties that you monitor in the stream.

properties*

object

propertyId

integer

required

The identifier of the property.

propertyName

string

required

The descriptive label for the property.

streamId

integer

required

Identifies the stream.

streamName

string

required

The name of the stream.

streamStatus

string

enum

required

Indicates if the stream is INACTIVE, ACTIVATING, ACTIVATED, DEACTIVATING, or DEACTIVATED.

INACTIVE ACTIVATING ACTIVATED DEACTIVATING DEACTIVATED

streamVersion

integer

required

Identifies the configuration version of the stream.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/datastream-config-api/v2/log/streams/streamId \
3
     --header 'accept: application/json'


xxxxxxxxxx
63
}
1
{
2
  "collectMidgress": true,
3
  "contractId": "C-0N7RAC7",
4
  "createdBy": "alfulani",
5
  "createdDate": "2022-02-05T13:31:30Z",
6
  "datasetFields": [
7
    {
8
      "datasetFieldId": 1000,
9
      "datasetFieldJsonKey": "cp",
10
      "datasetFieldName": "CP code"
11
    },
12
    {
13
      "datasetFieldId": 1002,
14
      "datasetFieldJsonKey": "reqId",
15
      "datasetFieldName": "Request ID"
16
    },
17
    {
18
      "datasetFieldId": 1023,
19
      "datasetFieldJsonKey": "cookie",
20
      "datasetFieldName": "Cookie"
21
    }
22
  ],
23
  "deliveryConfiguration": {
24
    "fieldDelimiter": "SPACE",
25
    "format": "STRUCTURED",
26
    "frequency": {
27
      "intervalInSeconds": 30
28
    },
29
    "uploadFilePrefix": "logs",
30
    "uploadFileSuffix": "ds"
31
  },
32
  "destination": {
33
    "bucket": "datastream.akamai.com",
34
    "compressLogs": true,
35
    "destinationType": "S3",
36
    "displayName": "S3Destination",
37
    "path": "ds2-logs",
38
    "region": "ap-south-1"
39
  },
40
  "groupId": 32145,
41
  "latestVersion": 1,
42
  "modifiedBy": "alfulani",
43
  "modifiedDate": "2022-02-05T13:31:30Z",
44
  "notificationEmails": [
45
    "useremail1@domain.com",
46
    "useremail2@domain.com"
47
  ],
48
  "productId": "Dynamic_Site_Accelerator",
49
  "properties": [

200The response returns stream version details.