type OldSample
counter_name
Name of the meter.
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
Must be the same value as {meterName} specified in the URL during creation. Note that the specified value cannot start with "fcx. (dot)".
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
counter_type
- gauge: Discrete value, fluctuating value
- delta: Differential value
- cumulative: Cumulative value
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Enum | 1..1 | None | None |
counter_unit
Unit of the meter.
Valid characters: Halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
counter_volume
The actual measured value
Range: -1E+308 to +1E+308
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Float | 1..1 | None | None |
message_id
This item is not specified during creation of the sample.
Note that this item may not be returned or may be returned with null value.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
project_id
ID of the project that owns the resource.
If omitted during creation of the sample, the project_id of the user that executed the API is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
recorded_at
Timestamp (UTC) of creation of the sample
Format: "YYYY-MM-DDThh:mm:ss.SSSSSS"
Even if this value is specified during creation of the sample, it will be ignored (a value is set automatically).
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Datetime | 0..1 | None | None |
resource_id
ID of the resource.
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 1..1 | None | None |
resource_metadata
Arbitrary metadata associated with the resource.
Contains multiple metadata key pairs in the following JSON format:
"{key1:value1, key2:value2, . . .}"
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
Maximum number of metadata items that can be specified: 10
Key names containing more than one period (.) will be returned with the second and subsequent periods replaced with colons (:). If f this is an issue, use another character such as underscore (_) instead.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| dict(String,String) | 0..1 | None | None |
source
Source where the sample comes from.
Valid characters: Fullwidth characters, halfwidth alphanumeric characters and halfwidth symbols
Number of characters: 1 to 255
The value is recorded using the format below (where project_id is the project_id specified during creation of the sample).
"project_id:source"
If omitted during creation of the sample, this element will be recorded as "fcx".
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |
timestamp
Timestamp (UTC) of measurement of the sample.
Format: "YYYY-MM-DDThh:mm:ss.SSS"
hh, mm, ss and SSS can be omitted.
If omitted, the time will become "0".
Example: If "2014-07-07T09:55" is specified, the timestamp becomes "2014-07-07T09:55:00.000".
The valid range is from two weeks beforehand to 2 hours afterward.
If omitted during creation of the sample, the value will be set automatically.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| Datetime | 0..1 | None | None |
user_id
ID of the user who created the resource or the user who last updated the meter.
If omitted during creation of the sample, the ID of the user that executed the API is used.
| Data type | Cardinality | Parent element | Child element |
|---|---|---|---|
| String | 0..1 | None | None |