{ "components": { "schemas": { "AlertProject": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "created_at", "icon", "id", "resource_id", "tags" ], "type": "object" }, "AlertProjectCreateRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "required": [ "name" ], "type": "object" }, "AlertProjectRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "AlertRule": { "properties": { "enabled_critical": { "type": "boolean" }, "enabled_warning": { "type": "boolean" }, "format": { "maxLength": 256, "type": "string" }, "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer" }, "name": { "maxLength": 256, "type": "string" }, "open": { "readOnly": true, "type": "boolean" }, "project_id": { "format": "int64", "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "query": { "maxLength": 4096, "type": "string" }, "template": { "maxLength": 256, "type": "string" }, "threshold_critical": { "maxLength": 256, "nullable": true, "type": "string" }, "threshold_duration_critical": { "format": "int64", "type": "integer" }, "threshold_duration_warning": { "format": "int64", "title": "Threshold duration", "type": "integer" }, "threshold_warning": { "maxLength": 256, "nullable": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "metrics_storage_id", "open", "project_id", "query", "uid" ], "type": "object" }, "AlertRuleRequest": { "properties": { "enabled_critical": { "type": "boolean" }, "enabled_warning": { "type": "boolean" }, "format": { "maxLength": 256, "type": "string" }, "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer" }, "name": { "maxLength": 256, "type": "string" }, "query": { "maxLength": 4096, "minLength": 1, "type": "string" }, "template": { "maxLength": 256, "type": "string" }, "threshold_critical": { "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "threshold_duration_critical": { "format": "int64", "type": "integer" }, "threshold_duration_warning": { "format": "int64", "title": "Threshold duration", "type": "integer" }, "threshold_warning": { "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" } }, "required": [ "metrics_storage_id", "query" ], "type": "object" }, "AndMatcher": { "properties": { "matchers": { "items": { "$ref": "#/components/schemas/FieldMatcher" }, "title": "Matchers", "type": "array" }, "type": { "enum": [ "and" ], "title": "Type", "type": "string" } }, "required": [ "type", "matchers" ], "title": "AndMatcher", "type": "object" }, "BoolMatcher": { "properties": { "field": { "$ref": "#/components/schemas/BooleanFieldName" }, "operator": { "$ref": "#/components/schemas/Operator2" }, "type": { "enum": [ "boolean" ], "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "boolean" } }, "required": [ "type", "operator", "field", "value" ], "title": "BoolMatcher", "type": "object" }, "BooleanFieldName": { "enum": [ "http_cache_lookup", "http_cache_hit" ], "title": "BooleanFieldName", "type": "string" }, "DashboardProject": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "created_at", "icon", "id", "resource_id", "tags" ], "type": "object" }, "DashboardProjectCreateRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "required": [ "name" ], "type": "object" }, "DashboardProjectRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "EnumMatcher": { "properties": { "field": { "$ref": "#/components/schemas/FieldModel" }, "type": { "enum": [ "enum" ], "title": "Type", "type": "string" }, "value": { "items": { "$ref": "#/components/schemas/ValueEnum" }, "title": "Value", "type": "array" } }, "required": [ "type", "field", "value" ], "title": "EnumMatcher", "type": "object" }, "FieldMatcher": { "discriminator": { "mapping": { "and": "#/components/schemas/AndMatcher", "boolean": "#/components/schemas/BoolMatcher", "enum": "#/components/schemas/EnumMatcher", "map-key-exists": "#/components/schemas/MapKeyExistsMatcher", "map-key-value-matcher": "#/components/schemas/MapKeyValueMatcher", "map-value-number": "#/components/schemas/MapValueNumMatcher", "map-value-string": "#/components/schemas/MapValueStrMatcher", "number": "#/components/schemas/NumMatcher", "or": "#/components/schemas/OrMatcher", "string": "#/components/schemas/StrMatcher" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/OrMatcher" }, { "$ref": "#/components/schemas/AndMatcher" }, { "$ref": "#/components/schemas/StrMatcher" }, { "$ref": "#/components/schemas/NumMatcher" }, { "$ref": "#/components/schemas/BoolMatcher" }, { "$ref": "#/components/schemas/EnumMatcher" }, { "$ref": "#/components/schemas/MapKeyExistsMatcher" }, { "$ref": "#/components/schemas/MapKeyValueMatcher" }, { "$ref": "#/components/schemas/MapValueStrMatcher" }, { "$ref": "#/components/schemas/MapValueNumMatcher" } ], "title": "FieldMatcher" }, "FieldModel": { "enum": [ "severity" ], "title": "FieldModel", "type": "string" }, "History": { "properties": { "endsAt": { "format": "date-time", "nullable": true, "title": "Ends_at", "type": "string" }, "labels": { "maxLength": 4096, "type": "string" }, "open": { "type": "boolean" }, "project_id": { "format": "int64", "readOnly": true, "type": "integer" }, "query": { "maxLength": 4096, "type": "string" }, "rule_uid": { "readOnly": true, "type": "string" }, "severity": { "description": "* `warning` - Warning\n* `critical` - Critical", "enum": [ "warning", "critical" ], "type": "string", "x-spec-enum-id": "eb2a007069bad0df" }, "startsAt": { "format": "date-time", "title": "Starts_at", "type": "string" }, "threshold": { "maxLength": 256, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "labels", "open", "project_id", "rule_uid", "severity", "startsAt", "uid" ], "type": "object" }, "LogMeasureRule": { "properties": { "created_at": { "format": "date-time", "readOnly": true, "type": "string" }, "description": { "maxLength": 256, "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "log_storage": { "allOf": [ { "$ref": "#/components/schemas/LogStorage" } ], "readOnly": true }, "metrics_storage": { "allOf": [ { "$ref": "#/components/schemas/MetricsStorage" } ], "readOnly": true }, "name": { "maxLength": 256, "pattern": "^[a-z\\d_-]*$", "type": "string" }, "project_id": { "format": "int64", "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "rule": { "$ref": "#/components/schemas/LogMeasureRuleModel" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "created_at", "id", "log_storage", "metrics_storage", "project_id", "rule", "uid", "updated_at" ], "type": "object" }, "LogMeasureRuleModel": { "properties": { "query": { "$ref": "#/components/schemas/LogMeasureRuleV1" }, "version": { "$ref": "#/components/schemas/LogMeasureRuleVersionEnum" } }, "required": [ "version", "query" ], "title": "LogMeasureRuleModel", "type": "object" }, "LogMeasureRuleModelRequest": { "properties": { "query": { "$ref": "#/components/schemas/LogMeasureRuleV1" }, "version": { "$ref": "#/components/schemas/LogMeasureRuleVersionEnum" } }, "required": [ "version", "query" ], "title": "LogMeasureRuleModel", "type": "object" }, "LogMeasureRuleRequest": { "properties": { "description": { "maxLength": 256, "type": "string" }, "log_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "name": { "maxLength": 256, "pattern": "^[a-z\\d_-]*$", "type": "string" }, "rule": { "$ref": "#/components/schemas/LogMeasureRuleModelRequest" } }, "required": [ "log_storage_id", "metrics_storage_id", "rule" ], "type": "object" }, "LogMeasureRuleV1": { "properties": { "matchers": { "items": { "$ref": "#/components/schemas/FieldMatcher" }, "title": "Matchers", "type": "array" } }, "required": [ "matchers" ], "title": "LogMeasureRuleV1", "type": "object" }, "LogMeasureRuleVersionEnum": { "enum": [ "v1" ], "title": "LogMeasureRuleVersionEnum", "type": "string" }, "LogRouting": { "properties": { "created_at": { "format": "date-time", "readOnly": true, "title": "Create datetime", "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "log_storage": { "allOf": [ { "$ref": "#/components/schemas/LogStorage" } ], "readOnly": true }, "publisher": { "allOf": [ { "$ref": "#/components/schemas/Publisher" } ], "readOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "variant": { "type": "string" } }, "required": [ "created_at", "id", "log_storage", "publisher", "uid", "updated_at", "variant" ], "type": "object" }, "LogRoutingRequest": { "properties": { "log_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "publisher_code": { "minLength": 1, "type": "string", "writeOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "variant": { "minLength": 1, "type": "string" } }, "required": [ "log_storage_id", "publisher_code", "variant" ], "type": "object" }, "LogStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "classification": { "enum": [ "shared", "dedicated" ], "readOnly": true, "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "ingester": { "properties": { "address": { "type": "string" }, "insecure": { "type": "boolean" } }, "required": [ "address" ], "type": "object" } }, "readOnly": true, "required": [ "ingester" ], "type": "object" }, "expire_day": { "readOnly": true, "type": "integer" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_system": { "readOnly": true, "type": "boolean" }, "kms_key_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "usage": { "properties": { "log_measure_rules": { "type": "integer" }, "log_routings": { "type": "integer" } }, "readOnly": true, "required": [ "log_routings", "log_measure_rules" ], "type": "object" } }, "required": [ "account_id", "classification", "created_at", "endpoints", "expire_day", "icon", "id", "is_system", "kms_key_id", "resource_id", "tags", "usage" ], "type": "object" }, "LogStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "secret": { "format": "uuid", "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "id", "secret", "token", "uid" ], "type": "object" }, "LogStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "LogStorageCreateRequest": { "properties": { "classification": { "default": "shared", "description": "* `shared` - 共用\n* `dedicated` - 専有", "enum": [ "shared", "dedicated" ], "type": "string", "x-spec-enum-id": "3896f704b7462b41" }, "description": { "maxLength": 512, "type": "string" }, "is_system": { "type": "boolean" }, "kms_key_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "type": "integer" } }, "required": [ "is_system", "name" ], "type": "object" }, "LogStorageDailyUsage": { "properties": { "date": { "format": "date", "readOnly": true, "type": "string" }, "ingested_bytes": { "readOnly": true, "type": "integer" }, "ingested_rows": { "readOnly": true, "type": "integer" }, "stored_bytes": { "nullable": true, "readOnly": true, "type": "integer" }, "timestamp": { "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "date", "ingested_bytes", "ingested_rows", "stored_bytes", "timestamp" ], "type": "object" }, "LogStorageDailyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/LogStorageDailyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "LogStorageMonthlyUsage": { "properties": { "ingested_bytes": { "readOnly": true, "type": "integer" }, "ingested_rows": { "readOnly": true, "type": "integer" }, "max_stored_bytes": { "readOnly": true, "type": "integer" }, "month": { "readOnly": true, "type": "integer" }, "timestamp": { "format": "date-time", "readOnly": true, "type": "string" }, "year": { "readOnly": true, "type": "integer" } }, "required": [ "ingested_bytes", "ingested_rows", "max_stored_bytes", "month", "timestamp", "year" ], "type": "object" }, "LogStorageMonthlyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/LogStorageMonthlyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "LogStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" }, "MapFieldName": { "enum": [ "resource_labels", "labels", "resource_attributes", "attributes", "json_payload" ], "title": "MapFieldName", "type": "string" }, "MapKeyExistsMatcher": { "properties": { "field": { "$ref": "#/components/schemas/MapFieldName" }, "key": { "title": "Key", "type": "string" }, "type": { "enum": [ "map-key-exists" ], "title": "Type", "type": "string" } }, "required": [ "type", "field", "key" ], "title": "MapKeyExistsMatcher", "type": "object" }, "MapKeyValueMatcher": { "properties": { "field": { "$ref": "#/components/schemas/MapFieldName" }, "key": { "title": "Key", "type": "string" }, "type": { "enum": [ "map-key-value-matcher" ], "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "type", "field", "key", "value" ], "title": "MapKeyValueMatcher", "type": "object" }, "MapValueNumMatcher": { "properties": { "field": { "$ref": "#/components/schemas/MapFieldName" }, "key": { "title": "Key", "type": "string" }, "operator": { "$ref": "#/components/schemas/Operator4" }, "type": { "enum": [ "map-value-number" ], "title": "Type", "type": "string" }, "value": { "format": "double", "title": "Value", "type": "number" }, "value_list": { "description": "use only multi-eq", "items": { "format": "double", "type": "number" }, "title": "Value List", "type": "array" } }, "required": [ "type", "operator", "field", "key", "value", "value_list" ], "title": "MapValueNumMatcher", "type": "object" }, "MapValueStrMatcher": { "properties": { "field": { "$ref": "#/components/schemas/MapFieldName" }, "key": { "title": "Key", "type": "string" }, "operator": { "$ref": "#/components/schemas/Operator3" }, "type": { "enum": [ "map-value-string" ], "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "value_list": { "items": { "type": "string" }, "title": "Value List", "type": "array" } }, "required": [ "type", "operator", "field", "key", "value", "value_list" ], "title": "MapValueStrMatcher", "type": "object" }, "MatchLabelsItem": { "properties": { "name": { "maxLength": 256, "type": "string" }, "value": { "maxLength": 256, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "MatchLabelsItemRequest": { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" }, "value": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "MetricsRouting": { "properties": { "created_at": { "format": "date-time", "readOnly": true, "title": "Create datetime", "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "metrics_storage": { "allOf": [ { "$ref": "#/components/schemas/MetricsStorage" } ], "readOnly": true }, "publisher": { "allOf": [ { "$ref": "#/components/schemas/Publisher" } ], "readOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "variant": { "type": "string" } }, "required": [ "created_at", "id", "metrics_storage", "publisher", "uid", "updated_at", "variant" ], "type": "object" }, "MetricsRoutingRequest": { "properties": { "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "publisher_code": { "minLength": 1, "type": "string", "writeOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "variant": { "minLength": 1, "type": "string" } }, "required": [ "metrics_storage_id", "publisher_code", "variant" ], "type": "object" }, "MetricsStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "address": { "type": "string" } }, "readOnly": true, "required": [ "address" ], "type": "object" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_system": { "readOnly": true, "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "usage": { "properties": { "alert_rules": { "type": "integer" }, "log_measure_rules": { "type": "integer" }, "metrics_routings": { "type": "integer" } }, "readOnly": true, "required": [ "metrics_routings", "alert_rules", "log_measure_rules" ], "type": "object" } }, "required": [ "account_id", "created_at", "endpoints", "icon", "id", "is_system", "resource_id", "tags", "updated_at", "usage" ], "type": "object" }, "MetricsStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "secret": { "format": "uuid", "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "id", "secret", "token", "uid" ], "type": "object" }, "MetricsStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "MetricsStorageCreateRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "is_system": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" } }, "required": [ "is_system", "name" ], "type": "object" }, "MetricsStorageDailyUsage": { "properties": { "date": { "format": "date", "readOnly": true, "type": "string" }, "ingested_rows": { "readOnly": true, "title": "Ingested samples", "type": "integer" }, "timestamp": { "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "date", "ingested_rows", "timestamp" ], "type": "object" }, "MetricsStorageDailyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/MetricsStorageDailyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "MetricsStorageMonthlyUsage": { "properties": { "ingested_rows": { "readOnly": true, "title": "Ingested samples", "type": "integer" }, "month": { "readOnly": true, "type": "integer" }, "timestamp": { "format": "date-time", "readOnly": true, "type": "string" }, "year": { "readOnly": true, "type": "integer" } }, "required": [ "ingested_rows", "month", "timestamp", "year" ], "type": "object" }, "MetricsStorageMonthlyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/MetricsStorageMonthlyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "MetricsStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "NotificationRouting": { "properties": { "match_labels": { "items": { "$ref": "#/components/schemas/MatchLabelsItem" }, "type": "array" }, "notification_target": { "allOf": [ { "$ref": "#/components/schemas/NotificationTarget" } ], "readOnly": true }, "order": { "readOnly": true, "type": "integer" }, "project_id": { "format": "int64", "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "resend_interval_minutes": { "maximum": 720, "minimum": 0, "type": "integer" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "match_labels", "notification_target", "order", "project_id", "uid" ], "type": "object" }, "NotificationRoutingOrderRequest": { "properties": { "notification_routing_uid": { "format": "uuid", "type": "string" }, "order": { "minimum": 1, "type": "integer" } }, "required": [ "notification_routing_uid", "order" ], "type": "object" }, "NotificationRoutingRequest": { "properties": { "match_labels": { "items": { "$ref": "#/components/schemas/MatchLabelsItemRequest" }, "type": "array" }, "notification_target_uid": { "format": "uuid", "type": "string", "writeOnly": true }, "resend_interval_minutes": { "maximum": 720, "minimum": 0, "type": "integer" } }, "required": [ "match_labels", "notification_target_uid" ], "type": "object" }, "NotificationTarget": { "properties": { "config": { "readOnly": true, "type": "object" }, "description": { "maxLength": 100, "type": "string" }, "project_id": { "format": "int64", "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "service_type": { "description": "* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification\n* `SAKURA_EVENT_BUS` - Sakura cloud event bus", "enum": [ "SAKURA_SIMPLE_NOTICE", "SAKURA_EVENT_BUS" ], "type": "string", "x-spec-enum-id": "3b143ded19bdc92e" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "url": { "maxLength": 1024, "type": "string" } }, "required": [ "config", "project_id", "service_type", "uid" ], "type": "object" }, "NotificationTargetRequest": { "properties": { "description": { "maxLength": 100, "type": "string" }, "service_type": { "description": "* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification\n* `SAKURA_EVENT_BUS` - Sakura cloud event bus", "enum": [ "SAKURA_SIMPLE_NOTICE", "SAKURA_EVENT_BUS" ], "type": "string", "x-spec-enum-id": "3b143ded19bdc92e" }, "url": { "maxLength": 1024, "type": "string" } }, "required": [ "service_type" ], "type": "object" }, "NumMatcher": { "properties": { "field": { "$ref": "#/components/schemas/NumberFieldName" }, "operator": { "$ref": "#/components/schemas/Operator1" }, "type": { "enum": [ "number" ], "title": "Type", "type": "string" }, "value": { "format": "double", "title": "Value", "type": "number" }, "value_list": { "description": "use only multi-eq", "items": { "format": "double", "type": "number" }, "title": "Value List", "type": "array" } }, "required": [ "type", "operator", "field", "value", "value_list" ], "title": "NumMatcher", "type": "object" }, "NumberFieldName": { "enum": [ "http_request_size", "http_status", "http_response_size", "http_remote_port", "http_latency_ns", "http_cache_fill_bytes", "sakuracloud_resource", "resource_dropped_attributes_count", "dropped_attributes_count", "span_duration_unix_nano" ], "title": "NumberFieldName", "type": "string" }, "Operator": { "enum": [ "eq", "ne", "gt", "lt", "gte", "lte", "multi-eq", "like", "ilike" ], "title": "Operator", "type": "string" }, "Operator1": { "enum": [ "eq", "ne", "gt", "lt", "gte", "lte", "multi-eq" ], "title": "Operator1", "type": "string" }, "Operator2": { "enum": [ "eq", "ne" ], "title": "Operator2", "type": "string" }, "Operator3": { "enum": [ "eq", "ne", "gt", "lt", "gte", "lte", "multi-eq", "like", "ilike" ], "title": "Operator3", "type": "string" }, "Operator4": { "enum": [ "eq", "ne", "gt", "lt", "gte", "lte", "multi-eq" ], "title": "Operator4", "type": "string" }, "OrMatcher": { "properties": { "matchers": { "items": { "$ref": "#/components/schemas/FieldMatcher" }, "title": "Matchers", "type": "array" }, "type": { "enum": [ "or" ], "title": "Type", "type": "string" } }, "required": [ "type", "matchers" ], "title": "OrMatcher", "type": "object" }, "PaginatedAlertProjectList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/AlertProject" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedAlertRuleList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/AlertRule" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedDashboardProjectList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/DashboardProject" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedHistoryList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/History" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedLogMeasureRuleList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/LogMeasureRule" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedLogRoutingList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/LogRouting" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedLogStorageAccessKeyList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/LogStorageAccessKey" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedLogStorageList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/LogStorage" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedMetricsRoutingList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/MetricsRouting" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedMetricsStorageAccessKeyList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/MetricsStorageAccessKey" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedMetricsStorageList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/MetricsStorage" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedNotificationRoutingList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/NotificationRouting" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedNotificationTargetList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/NotificationTarget" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedPublisherList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/Publisher" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedTraceStorageAccessKeyList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/TraceStorageAccessKey" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PaginatedTraceStorageList": { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "from": { "example": 0, "format": "int64", "type": "integer" }, "is_ok": { "example": true, "type": "boolean" }, "results": { "items": { "$ref": "#/components/schemas/TraceStorage" }, "type": "array" }, "total": { "example": 123, "format": "int64", "type": "integer" } }, "required": [ "count", "from", "total", "results" ], "type": "object" }, "PatchedAlertProjectRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "PatchedAlertRuleRequest": { "properties": { "enabled_critical": { "type": "boolean" }, "enabled_warning": { "type": "boolean" }, "format": { "maxLength": 256, "type": "string" }, "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer" }, "name": { "maxLength": 256, "type": "string" }, "query": { "maxLength": 4096, "minLength": 1, "type": "string" }, "template": { "maxLength": 256, "type": "string" }, "threshold_critical": { "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" }, "threshold_duration_critical": { "format": "int64", "type": "integer" }, "threshold_duration_warning": { "format": "int64", "title": "Threshold duration", "type": "integer" }, "threshold_warning": { "maxLength": 256, "minLength": 1, "nullable": true, "type": "string" } }, "type": "object" }, "PatchedDashboardProjectRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "PatchedLogMeasureRuleRequest": { "properties": { "description": { "maxLength": 256, "type": "string" }, "log_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "name": { "maxLength": 256, "pattern": "^[a-z\\d_-]*$", "type": "string" }, "rule": { "$ref": "#/components/schemas/LogMeasureRuleModelRequest" } }, "type": "object" }, "PatchedLogRoutingRequest": { "properties": { "log_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "publisher_code": { "minLength": 1, "type": "string", "writeOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "variant": { "minLength": 1, "type": "string" } }, "type": "object" }, "PatchedLogStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "PatchedLogStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" }, "PatchedMetricsRoutingRequest": { "properties": { "metrics_storage_id": { "format": "int64", "nullable": true, "title": "Cloud resource id", "type": "integer", "writeOnly": true }, "publisher_code": { "minLength": 1, "type": "string", "writeOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "variant": { "minLength": 1, "type": "string" } }, "type": "object" }, "PatchedMetricsStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "PatchedMetricsStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" } }, "type": "object" }, "PatchedNotificationRoutingRequest": { "properties": { "match_labels": { "items": { "$ref": "#/components/schemas/MatchLabelsItemRequest" }, "type": "array" }, "notification_target_uid": { "format": "uuid", "type": "string", "writeOnly": true }, "resend_interval_minutes": { "maximum": 720, "minimum": 0, "type": "integer" } }, "type": "object" }, "PatchedNotificationTargetRequest": { "properties": { "description": { "maxLength": 100, "type": "string" }, "service_type": { "description": "* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification\n* `SAKURA_EVENT_BUS` - Sakura cloud event bus", "enum": [ "SAKURA_SIMPLE_NOTICE", "SAKURA_EVENT_BUS" ], "type": "string", "x-spec-enum-id": "3b143ded19bdc92e" }, "url": { "maxLength": 1024, "type": "string" } }, "type": "object" }, "PatchedTraceStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "PatchedTraceStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" }, "Provisioning": { "properties": { "logs": { "$ref": "#/components/schemas/ProvisioningExist" }, "metrics": { "$ref": "#/components/schemas/ProvisioningExist" } }, "required": [ "logs", "metrics" ], "type": "object" }, "ProvisioningCreateRequest": { "properties": { "logs": { "$ref": "#/components/schemas/ProvisioningExistRequest" }, "metrics": { "$ref": "#/components/schemas/ProvisioningExistRequest" } }, "type": "object" }, "ProvisioningExist": { "properties": { "system_exist": { "type": "boolean" }, "user_exist": { "type": "boolean" } }, "required": [ "system_exist", "user_exist" ], "type": "object" }, "ProvisioningExistRequest": { "properties": { "system_exist": { "type": "boolean" }, "user_exist": { "type": "boolean" } }, "required": [ "system_exist", "user_exist" ], "type": "object" }, "Publisher": { "properties": { "code": { "maxLength": 256, "type": "string" }, "description": { "maxLength": 256, "type": "string" }, "variants": { "items": { "$ref": "#/components/schemas/PublisherVariant" }, "readOnly": true, "type": "array" } }, "required": [ "code", "variants" ], "type": "object" }, "PublisherAccessKeyIssueRequest": { "properties": { "account_id": { "minLength": 1, "type": "string" }, "description": { "type": "string" } }, "required": [ "account_id" ], "type": "object" }, "PublisherAccessKeyResponse": { "properties": { "account_id": { "maxLength": 20, "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "type": "string" }, "description": { "maxLength": 256, "type": "string" }, "expires_at": { "format": "date-time", "nullable": true, "type": "string" }, "id": { "readOnly": true, "type": "integer" }, "publisher": { "type": "integer" }, "secret": { "maxLength": 64, "type": "string" } }, "required": [ "account_id", "created_at", "id", "publisher" ], "type": "object" }, "PublisherRequest": { "properties": { "code": { "maxLength": 256, "minLength": 1, "type": "string" }, "description": { "maxLength": 256, "type": "string" } }, "required": [ "code" ], "type": "object" }, "PublisherVariant": { "properties": { "label": { "type": "string" }, "metrics_prefix": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "storage": { "description": "* `metrics` - metrics\n* `logs` - logs", "enum": [ "metrics", "logs" ], "type": "string", "x-spec-enum-id": "629e061395ff654f" }, "system": { "description": "* `disallow` - disallow\n* `required` - required", "enum": [ "disallow", "required" ], "type": "string", "x-spec-enum-id": "753020b5ff95d9fa" } }, "required": [ "label", "name", "storage", "system" ], "type": "object" }, "ResourceItemLimits": { "properties": { "max_user_count": { "description": "Max number of user shared resources.", "type": "integer" }, "max_user_dedicated_count": { "description": "Max number of user dedicated resources (if supported).", "type": "integer" } }, "required": [ "max_user_count" ], "type": "object" }, "ResourcesLimits": { "properties": { "alerts": { "$ref": "#/components/schemas/ResourceItemLimits" }, "dashboards": { "$ref": "#/components/schemas/ResourceItemLimits" }, "logs": { "$ref": "#/components/schemas/ResourceItemLimits" }, "metrics": { "$ref": "#/components/schemas/ResourceItemLimits" }, "traces": { "$ref": "#/components/schemas/ResourceItemLimits" } }, "required": [ "alerts", "dashboards", "logs", "metrics", "traces" ], "type": "object" }, "SetLogStorageExpireDayRequest": { "properties": { "days": { "maximum": 730, "minimum": 1, "type": "integer" } }, "required": [ "days" ], "type": "object" }, "SetTraceStorageExpireDayRequest": { "properties": { "days": { "maximum": 730, "minimum": 1, "type": "integer" } }, "required": [ "days" ], "type": "object" }, "StorageBucket": { "properties": { "access_key_id": { "maxLength": 256, "type": "string" }, "bucket_name": { "maxLength": 256, "type": "string" }, "classification": { "description": "* `shared` - 共用\n* `dedicated` - 専有", "enum": [ "shared", "dedicated" ], "type": "string", "x-spec-enum-id": "3896f704b7462b41" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "endpoint": { "description": "Storage Gatewayからアクセス可能なURL", "maxLength": 256, "type": "string" }, "id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "region": { "maxLength": 256, "type": "string" }, "secret_access_key": { "maxLength": 256, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "use_tls": { "type": "boolean" } }, "required": [ "access_key_id", "bucket_name", "created_at", "endpoint", "id", "secret_access_key", "updated_at" ], "type": "object" }, "StrMatcher": { "properties": { "field": { "$ref": "#/components/schemas/StringFieldName" }, "operator": { "$ref": "#/components/schemas/Operator" }, "type": { "enum": [ "string" ], "title": "Type", "type": "string" }, "value": { "title": "Value", "type": "string" }, "value_list": { "items": { "type": "string" }, "title": "Value List", "type": "array" } }, "required": [ "type", "operator", "field", "value", "value_list" ], "title": "StrMatcher", "type": "object" }, "StringFieldName": { "enum": [ "log_name", "insert_id", "resource_type", "http_request_method", "http_request_url", "http_user_agent", "http_remote_ip", "http_server_ip", "http_referer", "http_protocol", "http_schema", "http_user", "source_loc_file", "source_line", "source_function", "text_payload", "json_payload", "sakuracloud_publisher", "sakuracloud_variant", "sakuracloud_account", "trace_id", "span_id", "parent_span_id", "service_name", "service_instance_id", "service_namespace", "service_version", "deployment_environment_name", "span_name", "span_status_code_text" ], "title": "StringFieldName", "type": "string" }, "TraceStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "classification": { "enum": [ "shared", "dedicated" ], "readOnly": true, "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "ingester": { "properties": { "address": { "type": "string" }, "insecure": { "type": "boolean" } }, "required": [ "address" ], "type": "object" } }, "readOnly": true, "required": [ "ingester" ], "type": "object" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "kms_key_id": { "format": "int64", "nullable": true, "readOnly": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "retention_period_days": { "readOnly": true, "type": "integer" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "classification", "created_at", "endpoints", "icon", "id", "kms_key_id", "resource_id", "retention_period_days", "tags" ], "type": "object" }, "TraceStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "secret": { "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "secret", "token", "uid" ], "type": "object" }, "TraceStorageAccessKeyRequest": { "properties": { "description": { "maxLength": 256, "type": "string" } }, "type": "object" }, "TraceStorageCreateRequest": { "properties": { "classification": { "default": "shared", "description": "* `shared` - 共用\n* `dedicated` - 専有", "enum": [ "shared", "dedicated" ], "type": "string", "x-spec-enum-id": "3896f704b7462b41" }, "description": { "maxLength": 512, "type": "string" }, "kms_key_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "type": "integer" } }, "required": [ "name" ], "type": "object" }, "TraceStorageDailyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/LogStorageDailyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "TraceStorageMonthlyUsageBody": { "properties": { "usages": { "items": { "$ref": "#/components/schemas/LogStorageMonthlyUsage" }, "type": "array" } }, "required": [ "usages" ], "type": "object" }, "TraceStorageRequest": { "properties": { "description": { "maxLength": 512, "type": "string" }, "name": { "maxLength": 64, "type": "string" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" }, "User": { "properties": { "email": { "format": "email", "maxLength": 254, "title": "メールアドレス", "type": "string" }, "id": { "readOnly": true, "type": "integer" }, "username": { "description": "この項目は必須です。半角アルファベット、半角数字、@/./+/-/_ で150文字以下にしてください。", "maxLength": 150, "pattern": "^[\\w.@+-]+$", "title": "ユーザー名", "type": "string" } }, "required": [ "id", "username" ], "type": "object" }, "ValueEnum": { "enum": [ "DEFAULT", "DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "CRITICAL", "ALERT", "EMERGENCY" ], "title": "ValueEnum", "type": "string" }, "WrappedAlertProject": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_ok": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "created_at", "icon", "id", "is_ok", "resource_id", "tags" ], "type": "object" }, "WrappedDashboardProject": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_ok": { "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "created_at", "icon", "id", "is_ok", "resource_id", "tags" ], "type": "object" }, "WrappedLogRouting": { "properties": { "created_at": { "format": "date-time", "readOnly": true, "title": "Create datetime", "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "is_ok": { "type": "boolean" }, "log_storage": { "allOf": [ { "$ref": "#/components/schemas/LogStorage" } ], "readOnly": true }, "publisher": { "allOf": [ { "$ref": "#/components/schemas/Publisher" } ], "readOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "variant": { "type": "string" } }, "required": [ "created_at", "id", "is_ok", "log_storage", "publisher", "uid", "updated_at", "variant" ], "type": "object" }, "WrappedLogStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "classification": { "enum": [ "shared", "dedicated" ], "readOnly": true, "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "ingester": { "properties": { "address": { "type": "string" }, "insecure": { "type": "boolean" } }, "required": [ "address" ], "type": "object" } }, "readOnly": true, "required": [ "ingester" ], "type": "object" }, "expire_day": { "readOnly": true, "type": "integer" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_ok": { "type": "boolean" }, "is_system": { "readOnly": true, "type": "boolean" }, "kms_key_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "usage": { "properties": { "log_measure_rules": { "type": "integer" }, "log_routings": { "type": "integer" } }, "readOnly": true, "required": [ "log_routings", "log_measure_rules" ], "type": "object" } }, "required": [ "account_id", "classification", "created_at", "endpoints", "expire_day", "icon", "id", "is_ok", "is_system", "kms_key_id", "resource_id", "tags", "usage" ], "type": "object" }, "WrappedLogStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "is_ok": { "type": "boolean" }, "secret": { "format": "uuid", "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "id", "is_ok", "secret", "token", "uid" ], "type": "object" }, "WrappedMetricsRouting": { "properties": { "created_at": { "format": "date-time", "readOnly": true, "title": "Create datetime", "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "is_ok": { "type": "boolean" }, "metrics_storage": { "allOf": [ { "$ref": "#/components/schemas/MetricsStorage" } ], "readOnly": true }, "publisher": { "allOf": [ { "$ref": "#/components/schemas/Publisher" } ], "readOnly": true }, "resource_id": { "description": "対象リソースのID", "format": "int64", "nullable": true, "type": "integer" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "variant": { "type": "string" } }, "required": [ "created_at", "id", "is_ok", "metrics_storage", "publisher", "uid", "updated_at", "variant" ], "type": "object" }, "WrappedMetricsStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "address": { "type": "string" } }, "readOnly": true, "required": [ "address" ], "type": "object" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_ok": { "type": "boolean" }, "is_system": { "readOnly": true, "type": "boolean" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "nullable": true, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "Update datetime", "type": "string" }, "usage": { "properties": { "alert_rules": { "type": "integer" }, "log_measure_rules": { "type": "integer" }, "metrics_routings": { "type": "integer" } }, "readOnly": true, "required": [ "metrics_routings", "alert_rules", "log_measure_rules" ], "type": "object" } }, "required": [ "account_id", "created_at", "endpoints", "icon", "id", "is_ok", "is_system", "resource_id", "tags", "updated_at", "usage" ], "type": "object" }, "WrappedMetricsStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "id": { "deprecated": true, "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "type": "integer" }, "is_ok": { "type": "boolean" }, "secret": { "format": "uuid", "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "id", "is_ok", "secret", "token", "uid" ], "type": "object" }, "WrappedPublisher": { "properties": { "code": { "maxLength": 256, "type": "string" }, "description": { "maxLength": 256, "type": "string" }, "is_ok": { "type": "boolean" }, "variants": { "items": { "$ref": "#/components/schemas/PublisherVariant" }, "readOnly": true, "type": "array" } }, "required": [ "code", "is_ok", "variants" ], "type": "object" }, "WrappedTraceStorage": { "properties": { "account_id": { "readOnly": true, "title": "Cloud account id", "type": "string" }, "classification": { "enum": [ "shared", "dedicated" ], "readOnly": true, "type": "string" }, "created_at": { "format": "date-time", "readOnly": true, "title": "Register datetime", "type": "string" }, "description": { "maxLength": 512, "type": "string" }, "endpoints": { "properties": { "ingester": { "properties": { "address": { "type": "string" }, "insecure": { "type": "boolean" } }, "required": [ "address" ], "type": "object" } }, "readOnly": true, "required": [ "ingester" ], "type": "object" }, "icon": { "nullable": true, "properties": { "id": { "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "format": "int64", "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "is_ok": { "type": "boolean" }, "kms_key_id": { "format": "int64", "nullable": true, "readOnly": true, "type": "integer" }, "name": { "maxLength": 64, "type": "string" }, "resource_id": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "readOnly": true, "title": "Cloud resource id", "type": "integer" }, "retention_period_days": { "readOnly": true, "type": "integer" }, "service_principal_id": { "format": "int64", "nullable": true, "type": "integer" }, "tags": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "required": [ "account_id", "classification", "created_at", "endpoints", "icon", "id", "is_ok", "kms_key_id", "resource_id", "retention_period_days", "tags" ], "type": "object" }, "WrappedTraceStorageAccessKey": { "properties": { "description": { "maxLength": 256, "type": "string" }, "is_ok": { "type": "boolean" }, "secret": { "readOnly": true, "type": "string" }, "token": { "description": "Returns a token string for the access key.", "readOnly": true, "type": "string" }, "uid": { "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "is_ok", "secret", "token", "uid" ], "type": "object" } } }, "info": { "contact": { "name": "SAKURA internet Inc." }, "description": "\n---\n「モニタリングスイート」が提供するAPIの利用方法とサンプルを公開しております。\n# 基本的な使い方\n## APIキーの発行\nAPIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。\nAPIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。\n| 項目名 | APIキー発行時の項目名 | このドキュメント内での例 |\n|------------|------------------------------|--------------------------------------|\n| ユーザーID | アクセストークン(UUID) | 01234567-89ab-cdef-0123-456789abcdef |\n| パスワード | アクセストークンシークレット | SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM |\n\u003cdiv class=\"warning\"\u003e\n \u003cb\u003e操作マニュアル\u003c/b\u003e\u003cbr /\u003e\n \u003cul\u003e\u003cli\u003e\u003ca href=\"https://manual.sakura.ad.jp/cloud/api/apikey.html\"\u003eAPIキー | さくらのクラウド ドキュメント\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\u003c/div\u003e\n\n## 入力パラメータ\n\nAPIの入力には送信先URLに対して、いくつかのヘッダーとAPIキーを送信します。\n\n* 認証方式はHTTP Basic認証です。APIキーのアクセストークンをユーザーID、アクセストークンシークレットをパスワードとして指定します。\n* 常にリクエストのHTTPヘッダに `X-Sakura-Bigint-As-Int: 1` を付与してください。ヘッダが未指定の場合、一部のフィールドがこのドキュメントと異なる型でレスポンスされる場合があります。\n\n```\n# 入力サンプル\ncurl \\\n -u '01234567-89ab-cdef-0123-456789abcdef:SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM' \\\n -H 'X-Sakura-Bigint-As-Int: 1' \\\n -X GET \\\n 'https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/logs/storages/'\n```\n\n## 出力結果と応答コード（HTTPステータスコード）\n\nAPIからの結果は、「応答コード（HTTPステータスコード）」と、「JSON形式(UTF-8)の結果」として出力されます。\n\n応答コードは、リクエストが成功したのか、失敗したのか大まかな情報を判断することができるもので、例えば失敗したときには、なぜこのような結果になったのかなど、具体的な情報は応答コードと主に返された本文を見ることで把握することができます。\n\n| 結果 | 応答コード/status |\n|-------------------------------------|---------------------|\n| 成功（要求を受け付けた） | 2xx |\n| 失敗（要求が受け付けられなかった） | 4xx, 5xx |\n", "license": { "name": "Copyright(C) SAKURA internet Inc. all rights reserved." }, "title": "モニタリングスイート API ドキュメント", "version": "1.3.0" }, "openapi": "3.0.3", "paths": { "/alerts/projects/": { "get": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "listAlertProjects", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAlertProjectList" } } }, "description": "" } }, "summary": "アラートプロジェクト一覧取得API", "tags": [ "アラート" ] }, "post": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "createAlertProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertProjectCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertProjectCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertProjectCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertProject" } } }, "description": "" } }, "summary": "アラートプロジェクト作成API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/histories/": { "get": { "description": "アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。", "operationId": "listAlertProjectHistories", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "open", "schema": { "type": "boolean" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "* `warning` - Warning\n* `critical` - Critical", "in": "query", "name": "severity", "schema": { "enum": [ "critical", "warning" ], "type": "string", "x-spec-enum-id": "eb2a007069bad0df" } }, { "in": "query", "name": "startsAt", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHistoryList" } } }, "description": "" } }, "summary": "プロジェクトのアラート履歴一覧取得API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/histories/{uid}/": { "get": { "description": "アラートプロジェクト内のアラート履歴を取得するAPIエンドポイントです。", "operationId": "readAlertProjectHistory", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/History" } } }, "description": "" } }, "summary": "プロジェクトのアラート履歴詳細取得API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/log-measure-rules/": { "get": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "listAlertProjectLogMeasureRules", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "log_storage_id", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "metrics_storage_id", "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLogMeasureRuleList" } } }, "description": "" } }, "summary": "ログ計測ルール一覧取得API", "tags": [ "アラート" ] }, "post": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "createAlertProjectLogMeasureRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRule" } } }, "description": "" } }, "summary": "ログ計測ルール作成API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/log-measure-rules/{uid}/": { "delete": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "deleteAlertProjectLogMeasureRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "ログ計測ルール削除API", "tags": [ "アラート" ] }, "get": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "readAlertProjectLogMeasureRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRule" } } }, "description": "" } }, "summary": "ログ計測ルール詳細取得API", "tags": [ "アラート" ] }, "patch": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "patchAlertProjectLogMeasureRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLogMeasureRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLogMeasureRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLogMeasureRuleRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRule" } } }, "description": "" } }, "summary": "ログ計測ルール部分更新API", "tags": [ "アラート" ] }, "put": { "description": "ログベースメトリクスのための記録ルールを管理するAPIエンドポイントです。", "operationId": "updateAlertProjectLogMeasureRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogMeasureRuleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogMeasureRule" } } }, "description": "" } }, "summary": "ログ計測ルール更新API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/notification-routings/": { "get": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "listAlertProjectNotificationRoutings", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "target", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationRoutingList" } } }, "description": "" } }, "summary": "通知ルーティング一覧取得API", "tags": [ "アラート" ] }, "post": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "createAlertProjectNotificationRouting", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRouting" } } }, "description": "" } }, "summary": "通知ルーティング作成API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/notification-routings/reorder/": { "put": { "description": "アラートプロジェクト内の通知ルーティングの並び順を一括変更するAPIエンドポイントです。", "operationId": "reorderAlertProjectNotificationRoutings", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/NotificationRoutingOrderRequest" }, "type": "array" } }, "application/x-www-form-urlencoded": { "schema": { "items": { "$ref": "#/components/schemas/NotificationRoutingOrderRequest" }, "type": "array" } }, "multipart/form-data": { "schema": { "items": { "$ref": "#/components/schemas/NotificationRoutingOrderRequest" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No response body" } }, "summary": "通知ルーティング順序更新API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/notification-routings/{uid}/": { "delete": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "deleteAlertProjectNotificationRouting", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "通知ルーティング削除API", "tags": [ "アラート" ] }, "get": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "readAlertProjectNotificationRouting", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRouting" } } }, "description": "" } }, "summary": "通知ルーティング詳細取得API", "tags": [ "アラート" ] }, "patch": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "patchAlertProjectNotificationRouting", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNotificationRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNotificationRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNotificationRoutingRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRouting" } } }, "description": "" } }, "summary": "通知ルーティング部分更新API", "tags": [ "アラート" ] }, "put": { "description": "アラートプロジェクト内の通知ルーティングを管理するAPIエンドポイントです。", "operationId": "updateAlertProjectNotificationRouting", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NotificationRoutingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRouting" } } }, "description": "" } }, "summary": "通知ルーティング更新API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/notification-targets/": { "get": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "listAlertProjectNotificationTargets", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "* `SAKURA_SIMPLE_NOTICE` - Sakura cloud simple notification\n* `SAKURA_EVENT_BUS` - Sakura cloud event bus", "in": "query", "name": "service_type", "schema": { "enum": [ "SAKURA_EVENT_BUS", "SAKURA_SIMPLE_NOTICE" ], "type": "string", "x-spec-enum-id": "3b143ded19bdc92e" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNotificationTargetList" } } }, "description": "" } }, "summary": "通知対象一覧取得API", "tags": [ "アラート" ] }, "post": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "createAlertProjectNotificationTarget", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTarget" } } }, "description": "" } }, "summary": "通知対象作成API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/notification-targets/{uid}/": { "delete": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "deleteAlertProjectNotificationTarget", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "通知対象削除API", "tags": [ "アラート" ] }, "get": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "readAlertProjectNotificationTarget", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTarget" } } }, "description": "" } }, "summary": "通知対象詳細取得API", "tags": [ "アラート" ] }, "patch": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "patchAlertProjectNotificationTarget", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNotificationTargetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNotificationTargetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNotificationTargetRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTarget" } } }, "description": "" } }, "summary": "通知対象部分更新API", "tags": [ "アラート" ] }, "put": { "description": "アラートプロジェクト内の通知対象を管理するAPIエンドポイントです。", "operationId": "updateAlertProjectNotificationTarget", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NotificationTargetRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTarget" } } }, "description": "" } }, "summary": "通知対象更新API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/rules/": { "get": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "listAlertProjectRules", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAlertRuleList" } } }, "description": "" } }, "summary": "アラートルール一覧取得API", "tags": [ "アラート" ] }, "post": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "createAlertProjectRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } }, "description": "" } }, "summary": "アラートルール作成API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/rules/{ruleUid}/histories/": { "get": { "description": "ルール内のアラート履歴を取得するAPIエンドポイントです。", "operationId": "listAlertProjectRuleHistories", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "open", "schema": { "type": "boolean" } }, { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "ruleUid", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "* `warning` - Warning\n* `critical` - Critical", "in": "query", "name": "severity", "schema": { "enum": [ "critical", "warning" ], "type": "string", "x-spec-enum-id": "eb2a007069bad0df" } }, { "in": "query", "name": "startsAt", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHistoryList" } } }, "description": "" } }, "summary": "ルールのアラート履歴一覧取得API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/rules/{ruleUid}/histories/{uid}/": { "get": { "description": "ルール内のアラート履歴を取得するAPIエンドポイントです。", "operationId": "readAlertProjectRuleHistory", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "ruleUid", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/History" } } }, "description": "" } }, "summary": "ルールのアラート履歴詳細取得API", "tags": [ "アラート" ] } }, "/alerts/projects/{projectResourceId}/rules/{uid}/": { "delete": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "deleteAlertProjectRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "アラートルール削除API", "tags": [ "アラート" ] }, "get": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "readAlertProjectRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } }, "description": "" } }, "summary": "アラートルール詳細取得API", "tags": [ "アラート" ] }, "patch": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "patchAlertProjectRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAlertRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAlertRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAlertRuleRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } }, "description": "" } }, "summary": "アラートルール部分更新API", "tags": [ "アラート" ] }, "put": { "description": "アラートプロジェクト内のアラートルールを管理するためのAPIエンドポイントです。", "operationId": "updateAlertProjectRule", "parameters": [ { "in": "path", "name": "projectResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertRuleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertRule" } } }, "description": "" } }, "summary": "アラートルール更新API", "tags": [ "アラート" ] } }, "/alerts/projects/{resourceId}/": { "delete": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "deleteAlertProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "アラートプロジェクト削除API", "tags": [ "アラート" ] }, "get": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "readAlertProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedAlertProject" } } }, "description": "" } }, "summary": "アラートプロジェクト詳細取得API", "tags": [ "アラート" ] }, "patch": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "patchAlertProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAlertProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAlertProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAlertProjectRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedAlertProject" } } }, "description": "" } }, "summary": "アラートプロジェクト部分更新API", "tags": [ "アラート" ] }, "put": { "description": "アラートプロジェクトを管理するためのAPIエンドポイントです。", "operationId": "updateAlertProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlertProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlertProjectRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedAlertProject" } } }, "description": "" } }, "summary": "アラートプロジェクト更新API", "tags": [ "アラート" ] } }, "/dashboards/projects/": { "get": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "listDashboardProjects", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDashboardProjectList" } } }, "description": "" } }, "summary": "ダッシュボード一覧取得API", "tags": [ "ダッシュボード" ] }, "post": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "createDashboardProject", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardProjectCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardProjectCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardProjectCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardProject" } } }, "description": "" } }, "summary": "ダッシュボード作成API", "tags": [ "ダッシュボード" ] } }, "/dashboards/projects/{resourceId}/": { "delete": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "deleteDashboardProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "ダッシュボード削除API", "tags": [ "ダッシュボード" ] }, "get": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "readDashboardProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedDashboardProject" } } }, "description": "" } }, "summary": "ダッシュボード詳細取得API", "tags": [ "ダッシュボード" ] }, "patch": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "patchDashboardProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDashboardProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDashboardProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDashboardProjectRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedDashboardProject" } } }, "description": "" } }, "summary": "ダッシュボード部分更新API", "tags": [ "ダッシュボード" ] }, "put": { "description": "ダッシュボードを管理するためのAPIエンドポイントです。", "operationId": "updateDashboardProject", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardProjectRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DashboardProjectRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DashboardProjectRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedDashboardProject" } } }, "description": "" } }, "summary": "ダッシュボード更新API", "tags": [ "ダッシュボード" ] } }, "/logs/routings/": { "get": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "listLogRoutings", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "publisher__code", "schema": { "type": "string" } }, { "description": "Log storage resource id", "in": "query", "name": "resource_id", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "variant", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLogRoutingList" } } }, "description": "" } }, "summary": "ログルーティング一覧取得API", "tags": [ "ログルーティング" ] }, "post": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "createLogRouting", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogRouting" } } }, "description": "" } }, "summary": "ログルーティング作成API", "tags": [ "ログルーティング" ] } }, "/logs/routings/{uid}/": { "delete": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "deleteLogRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "ログルーティング削除API", "tags": [ "ログルーティング" ] }, "get": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "readLogRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogRouting" } } }, "description": "" } }, "summary": "ログルーティング詳細取得API", "tags": [ "ログルーティング" ] }, "patch": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "patchLogRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLogRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLogRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLogRoutingRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogRouting" } } }, "description": "" } }, "summary": "ログルーティング部分更新API", "tags": [ "ログルーティング" ] }, "put": { "description": "ログルーティングを管理するためのAPIエンドポイントです。", "operationId": "updateLogRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogRoutingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogRouting" } } }, "description": "" } }, "summary": "ログルーティング更新API", "tags": [ "ログルーティング" ] } }, "/logs/storages/": { "get": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "listLogStorages", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "* `shared` - 共用\n* `dedicated` - 専有", "in": "query", "name": "bucket__classification", "schema": { "enum": [ "dedicated", "shared" ], "type": "string", "x-spec-enum-id": "3896f704b7462b41" } }, { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "description": "Is system", "in": "query", "name": "is_system", "schema": { "type": "boolean" } }, { "in": "query", "name": "resource_id", "schema": { "format": "int64", "type": "integer" } }, { "description": "* `init` - 初期化中\n* `free` - 未割り当て\n* `assigned` - 割り当て済み\n* `deleted` - 削除済み\n* `purged` - ログデータ削除済み", "in": "query", "name": "status", "schema": { "enum": [ "assigned", "deleted", "free", "init", "purged" ], "type": "string", "x-spec-enum-id": "6499fdb0e233089a" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLogStorageList" } } }, "description": "" } }, "summary": "ログストレージ一覧取得API", "tags": [ "ログストレージ" ] }, "post": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "createLogStorage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogStorageCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogStorageCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorage" } } }, "description": "" } }, "summary": "ログストレージ作成API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{logResourceId}/keys/": { "get": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "listLogStorageKeys", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLogStorageAccessKeyList" } } }, "description": "" } }, "summary": "ログストレージのアクセスキー一覧取得API", "tags": [ "ログストレージ" ] }, "post": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "createLogStorageKey", "parameters": [ { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorageAccessKey" } } }, "description": "" } }, "summary": "ログストレージのアクセスキー作成API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{logResourceId}/keys/{uid}/": { "delete": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "deleteLogStorageKey", "parameters": [ { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "ログストレージのアクセスキー削除API", "tags": [ "ログストレージ" ] }, "get": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "readLogStorageKey", "parameters": [ { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorageAccessKey" } } }, "description": "" } }, "summary": "ログストレージのアクセスキー詳細取得API", "tags": [ "ログストレージ" ] }, "patch": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "patchLogStorageKey", "parameters": [ { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorageAccessKey" } } }, "description": "" } }, "summary": "ログストレージのアクセスキー部分更新API", "tags": [ "ログストレージ" ] }, "put": { "description": "ログストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "updateLogStorageKey", "parameters": [ { "in": "path", "name": "logResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorageAccessKey" } } }, "description": "" } }, "summary": "ログストレージのアクセスキー更新API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{resourceId}/": { "delete": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "deleteLogStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "ログストレージ削除API", "tags": [ "ログストレージ" ] }, "get": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "readLogStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorage" } } }, "description": "" } }, "summary": "ログストレージ詳細取得API", "tags": [ "ログストレージ" ] }, "patch": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "patchLogStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLogStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorage" } } }, "description": "" } }, "summary": "ログストレージ部分更新API", "tags": [ "ログストレージ" ] }, "put": { "description": "ログストレージを管理するためのAPIエンドポイントです。", "operationId": "updateLogStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LogStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LogStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedLogStorage" } } }, "description": "" } }, "summary": "ログストレージ更新API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{resourceId}/set-expire/": { "post": { "description": "ログストレージの保存期間を設定します。", "operationId": "setLogStorageExpire", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLogStorageExpireDayRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SetLogStorageExpireDayRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SetLogStorageExpireDayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorage" } } }, "description": "" } }, "summary": "ログストレージ有効期限設定API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{resourceId}/stats/daily/": { "get": { "description": "ログストレージの日次利用状況を取得します。", "operationId": "readLogStorageStatsDaily", "parameters": [ { "in": "query", "name": "end_date", "schema": { "format": "date", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "start_date", "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageDailyUsageBody" } } }, "description": "" } }, "summary": "ログストレージ日次利用状況詳細取得API", "tags": [ "ログストレージ" ] } }, "/logs/storages/{resourceId}/stats/monthly/": { "get": { "description": "ログストレージの月次利用状況を取得します。", "operationId": "readLogStorageStatsMonthly", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 1970, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStorageMonthlyUsageBody" } } }, "description": "" } }, "summary": "ログストレージ月次利用状況詳細取得API", "tags": [ "ログストレージ" ] } }, "/management/limits/": { "get": { "description": "アカウントのリソース上限（ログストレージ、メトリクスストレージ、アラートプロジェクト、ダッシュボード）を取得するAPIエンドポイントです。", "operationId": "readResourceLimits", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourcesLimits" } } }, "description": "" } }, "summary": "リソース制限詳細取得API", "tags": [ "管理" ] } }, "/management/provisioning/initialize/": { "post": { "description": "リソース（ログストレージ、メトリクスストレージ）のプロビジョニング（初期化）を行うAPIエンドポイントです。指定した種別のリソースが存在しない場合のみ作成を行います。既存のリソースは変更されません。", "operationId": "initializeProvisioning", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProvisioningCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProvisioningCreateRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Provisioning" } } }, "description": "既存のリソースが存在し、新規作成を行わなかった場合に返されます。" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Provisioning" } } }, "description": "新規リソースを作成した場合に返されます。" } }, "summary": "プロビジョニング（初期化）API", "tags": [ "管理" ] } }, "/management/provisioning/state/": { "get": { "description": "リソース（ログストレージ、メトリクスストレージ）のプロビジョニング状態を確認するAPIエンドポイントです。", "operationId": "readProvisioningState", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Provisioning" } } }, "description": "" } }, "summary": "プロビジョニング状態詳細取得API", "tags": [ "管理" ] } }, "/metrics/routings/": { "get": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "listMetricRoutings", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "publisher__code", "schema": { "type": "string" } }, { "description": "Metrics storage resource id", "in": "query", "name": "resource_id", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "variant", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricsRoutingList" } } }, "description": "" } }, "summary": "メトリクスルーティング一覧取得API", "tags": [ "メトリクスルーティング" ] }, "post": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "createMetricRouting", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsRouting" } } }, "description": "" } }, "summary": "メトリクスルーティング作成API", "tags": [ "メトリクスルーティング" ] } }, "/metrics/routings/{uid}/": { "delete": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "deleteMetricRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "メトリクスルーティング削除API", "tags": [ "メトリクスルーティング" ] }, "get": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "readMetricRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsRouting" } } }, "description": "" } }, "summary": "メトリクスルーティング詳細取得API", "tags": [ "メトリクスルーティング" ] }, "patch": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "patchMetricRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricsRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricsRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricsRoutingRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsRouting" } } }, "description": "" } }, "summary": "メトリクスルーティング部分更新API", "tags": [ "メトリクスルーティング" ] }, "put": { "description": "メトリクスルーティングを管理するためのAPIエンドポイントです。", "operationId": "updateMetricRouting", "parameters": [ { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsRoutingRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsRouting" } } }, "description": "" } }, "summary": "メトリクスルーティング更新API", "tags": [ "メトリクスルーティング" ] } }, "/metrics/storages/": { "get": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "listMetricStorages", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "description": "Is system", "in": "query", "name": "is_system", "schema": { "type": "boolean" } }, { "in": "query", "name": "resource_id", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricsStorageList" } } }, "description": "" } }, "summary": "メトリクスストレージ一覧取得API", "tags": [ "メトリクスストレージ" ] }, "post": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "createMetricStorage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsStorageCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsStorageCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorage" } } }, "description": "" } }, "summary": "メトリクスストレージ作成API", "tags": [ "メトリクスストレージ" ] } }, "/metrics/storages/{metricsResourceId}/keys/": { "get": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "listMetricStorageKeys", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMetricsStorageAccessKeyList" } } }, "description": "" } }, "summary": "メトリクスストレージのアクセスキー一覧取得API", "tags": [ "メトリクスストレージ" ] }, "post": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "createMetricStorageKey", "parameters": [ { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorageAccessKey" } } }, "description": "" } }, "summary": "メトリクスストレージのアクセスキー作成API", "tags": [ "メトリクスストレージ" ] } }, "/metrics/storages/{metricsResourceId}/keys/{uid}/": { "delete": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "deleteMetricStorageKey", "parameters": [ { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "メトリクスストレージのアクセスキー削除API", "tags": [ "メトリクスストレージ" ] }, "get": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "readMetricStorageKey", "parameters": [ { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorageAccessKey" } } }, "description": "" } }, "summary": "メトリクスストレージのアクセスキー詳細取得API", "tags": [ "メトリクスストレージ" ] }, "patch": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "patchMetricStorageKey", "parameters": [ { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorageAccessKey" } } }, "description": "" } }, "summary": "メトリクスストレージのアクセスキー部分更新API", "tags": [ "メトリクスストレージ" ] }, "put": { "description": "メトリクスストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "updateMetricStorageKey", "parameters": [ { "in": "path", "name": "metricsResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorageAccessKey" } } }, "description": "" } }, "summary": "メトリクスストレージのアクセスキー更新API", "tags": [ "メトリクスストレージ" ] } }, "/metrics/storages/{resourceId}/": { "delete": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "deleteMetricStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "メトリクスストレージ削除API", "tags": [ "メトリクスストレージ" ] }, "get": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "readMetricStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorage" } } }, "description": "" } }, "summary": "メトリクスストレージ詳細取得API", "tags": [ "メトリクスストレージ" ] }, "patch": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "patchMetricStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedMetricsStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorage" } } }, "description": "" } }, "summary": "メトリクスストレージ部分更新API", "tags": [ "メトリクスストレージ" ] }, "put": { "description": "メトリクスストレージを管理するためのAPIエンドポイントです。", "operationId": "updateMetricStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MetricsStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MetricsStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedMetricsStorage" } } }, "description": "" } }, "summary": "メトリクスストレージ更新API", "tags": [ "メトリクスストレージ" ] } }, "/metrics/storages/{resourceId}/stats/daily/": { "get": { "description": "メトリクスストレージの日次利用状況を取得します。", "operationId": "readMetricStorageStatsDaily", "parameters": [ { "in": "query", "name": "end_date", "schema": { "format": "date", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "start_date", "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageDailyUsageBody" } } }, "description": "" } }, "summary": "メトリクスストレージ日次利用状況詳細取得API", "tags": [ "メトリクスストレージ" ] } }, "/metrics/storages/{resourceId}/stats/monthly/": { "get": { "description": "メトリクスストレージの月次利用状況を取得します。", "operationId": "readMetricStorageStatsMonthly", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 1970, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricsStorageMonthlyUsageBody" } } }, "description": "" } }, "summary": "メトリクスストレージ月次利用状況詳細取得API", "tags": [ "メトリクスストレージ" ] } }, "/publishers/": { "get": { "description": "連携サービス情報を取得するAPIエンドポイントです。", "operationId": "listPublishers", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPublisherList" } } }, "description": "" } }, "summary": "連携サービス一覧取得API", "tags": [ "連携サービス" ] } }, "/publishers/{code}/": { "get": { "description": "連携サービス情報を取得するAPIエンドポイントです。", "operationId": "readPublisher", "parameters": [ { "in": "path", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPublisher" } } }, "description": "" } }, "summary": "連携サービス詳細取得API", "tags": [ "連携サービス" ] } }, "/traces/storages/": { "get": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "listTraceStorages", "parameters": [ { "in": "query", "name": "account_id", "schema": { "type": "string" } }, { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "description": "* `shared` - 共用\n* `dedicated` - 専有", "in": "query", "name": "log_storage__bucket__classification", "schema": { "enum": [ "dedicated", "shared" ], "type": "string", "x-spec-enum-id": "3896f704b7462b41" } }, { "in": "query", "name": "resource_id", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTraceStorageList" } } }, "description": "" } }, "summary": "トレースストレージ一覧取得API", "tags": [ "トレースストレージ" ] }, "post": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "createTraceStorage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TraceStorageCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TraceStorageCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorage" } } }, "description": "" } }, "summary": "トレースストレージ作成API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{resourceId}/": { "delete": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "deleteTraceStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "トレースストレージ削除API", "tags": [ "トレースストレージ" ] }, "get": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "readTraceStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorage" } } }, "description": "" } }, "summary": "トレースストレージ詳細取得API", "tags": [ "トレースストレージ" ] }, "patch": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "patchTraceStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorage" } } }, "description": "" } }, "summary": "トレースストレージ部分更新API", "tags": [ "トレースストレージ" ] }, "put": { "description": "トレースストレージを管理するためのAPIエンドポイントです。", "operationId": "updateTraceStorage", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TraceStorageRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TraceStorageRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorage" } } }, "description": "" } }, "summary": "トレースストレージ更新API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{resourceId}/set-expire/": { "post": { "description": "トレースストレージの保存期間を設定します。", "operationId": "setTraceStorageExpire", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetTraceStorageExpireDayRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SetTraceStorageExpireDayRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SetTraceStorageExpireDayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorage" } } }, "description": "" } }, "summary": "トレースストレージ有効期限設定API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{resourceId}/stats/daily/": { "get": { "description": "トレースストレージの日次利用状況を取得します。", "operationId": "readTraceStorageStatsDaily", "parameters": [ { "in": "query", "name": "end_date", "schema": { "format": "date", "type": "string" } }, { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "start_date", "schema": { "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageDailyUsageBody" } } }, "description": "" } }, "summary": "トレースストレージ日次利用状況詳細取得API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{resourceId}/stats/monthly/": { "get": { "description": "トレースストレージの月次利用状況を取得します。", "operationId": "readTraceStorageStatsMonthly", "parameters": [ { "in": "path", "name": "resourceId", "required": true, "schema": { "example": 110000000000, "format": "int64", "maximum": 999999999999, "minimum": 0, "title": "Cloud resource id", "type": "integer" } }, { "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 1970, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageMonthlyUsageBody" } } }, "description": "" } }, "summary": "トレースストレージ月次利用状況詳細取得API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{traceResourceId}/keys/": { "get": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "listTraceStorageKeys", "parameters": [ { "description": "Number of results to return per page.", "in": "query", "name": "count", "required": false, "schema": { "type": "integer" } }, { "description": "The initial index from which to return the results.", "in": "query", "name": "from", "required": false, "schema": { "type": "integer" } }, { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTraceStorageAccessKeyList" } } }, "description": "" } }, "summary": "トレースストレージのアクセスキー一覧取得API", "tags": [ "トレースストレージ" ] }, "post": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "createTraceStorageKey", "parameters": [ { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorageAccessKey" } } }, "description": "" } }, "summary": "トレースストレージのアクセスキー作成API", "tags": [ "トレースストレージ" ] } }, "/traces/storages/{traceResourceId}/keys/{uid}/": { "delete": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "deleteTraceStorageKey", "parameters": [ { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "204": { "description": "No response body" } }, "summary": "トレースストレージのアクセスキー削除API", "tags": [ "トレースストレージ" ] }, "get": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "readTraceStorageKey", "parameters": [ { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorageAccessKey" } } }, "description": "" } }, "summary": "トレースストレージのアクセスキー詳細取得API", "tags": [ "トレースストレージ" ] }, "patch": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "patchTraceStorageKey", "parameters": [ { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTraceStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorageAccessKey" } } }, "description": "" } }, "summary": "トレースストレージのアクセスキー部分更新API", "tags": [ "トレースストレージ" ] }, "put": { "description": "トレースストレージのアクセスキーを管理するAPIエンドポイントです。", "operationId": "updateTraceStorageKey", "parameters": [ { "in": "path", "name": "traceResourceId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "in": "path", "name": "uid", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TraceStorageAccessKeyRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedTraceStorageAccessKey" } } }, "description": "" } }, "summary": "トレースストレージのアクセスキー更新API", "tags": [ "トレースストレージ" ] } } }, "servers": [ { "url": "https://secure.sakura.ad.jp/cloud/zone/is1a/api/monitoring/1.0/" } ] }