M2A Compute Internal API (jenkins)

Download OpenAPI specification:Download

URL: https://m2amedia.tv/docs License: MIT

Endpoints to perform CRUD (create, read, update, delete) operations on compute-resources.

M2A Computer Public API

Create and delete compute resources to run custom pre-defined services.

Get Health Status

Authorizations:

public

Responses

Response samples

200
405
500

Content type

application/json

{"status": "string",
"api-version": "string",
"build-version": "string"
}

Get Compute Resource

Authorizations:

http_security_schema

path Parameters

compute_resource_id

required

string

query Parameters

owner

required

string <uuid>

header Parameters

accept	string Value: "application/vnd.api+json" Content type (expressed as MIME types) the client is able to understand.
Content-Type	string Value: "application/vnd.api+json" The original media type of the resource.

Responses

Response samples

Content type

application/vnd.api+json

{"data": {"attributes": {"resource-type": "asg",
"name": "A norsk plp instance",
"state": "DEFINED",
"state-callback": {"internal-url": "https://internal.cloud.m2amedia.tv/v1/"
},
"configuration-id": "b0e30656-8a1a-4eb7-ad3e-bbd8084fb58a",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"last-modified-by": "c1839b4f-ddea-43f0-abd3-607484b0170b",
"log-groups": [{"name": "/m2a/compute-resources/norsk-plp/norsk-launch",
"description": "Logs for Norsk PLP launch processes",
"display-name": "Norsk PLP Launch Logs",
"arn": "arn:aws:logs:eu-west-1:452147389173:log-group:/m2a/compute-resources/norsk-plp/norsk-launch:*"
}
],
"activations": [{"activation-id": "act-1234567890abcdef",
"activated-at": "2019-08-24T14:15:22Z",
"deactivated-at": "2019-08-24T14:15:22Z"
}
],
"service": {"type": "norsk-plp",
"settings": {"source-url": "srt://52.208.64.107:7070",
"overlay-url": "https://aero.aelive.cloud/?renderer=OP-DEMO_RENDERER92",
"archive-destination": "s3://archive/<prefix>"
},
"output": {"service-console": {"url": "https://console.norskplp.example.com/session/abc123",
"credentials": {"credential-type": "http-basic",
"username": "api_user",
"password": "supersecurepassword123"
}
}
},
"display-name": "Norsk PLP Service"
},
"desired-capacity": 5,
"metadata": {"labels": [{"key": "string",
"value": "string"
}
]
},
"instance-types": ["m5.large"
],
"location": {"availability-zones": ["eu-north-1b"
],
"subnet-ids": ["subnet-9f8e7d6c"
]
},
"launch-template-id": "025ba594-2f78-428b-b883-43d9b04b20be",
"instances": [{"instance-id": "instance-abc",
"private-ip": "172.31.2.5",
"public-ip": "3.234.56.78",
"state": "running",
"subnet-id": "subnet-9f8e7d6c",
"availability-zone": "eu-north-1b",
"instance-type": "m5.large",
"launch-time": "2019-08-24T14:15:22Z"
}
],
"asg-arn": "arn:aws:autoscaling:eu-north-1:123456789012:autoScalingGroup:...",
"asg-name": "norsk-plp-asg-<id>"
},
"relationships": {"owner": {"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "target-account"
}
},
"creator": {"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "principal"
}
},
"workflow-event": {"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "schedule-event"
}
}
},
"type": "compute-resource",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}