• Register Geozone
• Read Geozone
• List Geozones
• Delete Geozone
• Register Region
• Read Region
• List Regions
• List Regions of a Geozone
• Delete Region

ABOUT ON GEO INFO MANAGEMENT:

Geo information is an optional feature in the context of Stream Manager based Red5 Pro autoscaling. This api allows you to teach Stream Manager about the geographical topology of the service being provided through Stream Manager. Later when requesting an edge or a origin, you can specify a geozone code instead of a region in the Read Stream api request and Stream Manager will know which regions are being targeted.

Register Geozone

Description

Registers a geozone by name and code. A geozone is a macro location such as a continent etc. A geozone may group contain one or more regions.

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone?accessToken=<accessToken>
• Method: POST
• Data: JSON

    {
          "name": "<geozone-name>",
          "code": "<geozone-code>"
    }

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 201
• Data:

    {
        "name": "<geozone-name>",
        "code": "<geozone-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone?accessToken=xyz123
• Method: POST
• Data : JSON

    {
          "name": "Asia",
          "code": "asia"

RESPONSE

• Success: HTTP CODE 201
• Data:

    {
          "name": "Asia",
          "code": "asia"
    }

Read Geozone

Description

Reads a geozone by code.

REQUEST

• URI : http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/<geozone-code>?accessToken=<accessToken>
• Method: GET

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    {
        "name": "<geozone-name>",
        "code": "<geozone-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/asia?accessToken=xyz123
• Method: GET

RESPONSE

• Success: HTTP CODE 200
• Data:

    {
          "name": "Asia",
          "code": "asia"
    }

List Geozones

Description

List all registered geozones.

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone?accessToken=<accessToken>
• Method: GET

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "<geozone-name>",
            "code": "<geozone-code>"
        }
    ]

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone?accessToken=xyz123
• Method: GET

RESPONSE

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "Asia",
            "code": "asia"
        }
    ]

Delete Geozone

Description

Deletes a geozone by code. When deletting a geozone, all associated regions will also be removed automatically.

REQUEST

• URI : http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/<geozone-code>?accessToken=<accessToken>
• Method: DELETE

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    {
        "name": "<geozone-name>",
        "code": "<geozone-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/asia?accessToken=xyz123
• Method: DELETE

RESPONSE

• Success: HTTP CODE 200
• Data:

    {
          "name": "Asia",
          "code": "asia"
    }

Register Region

Description

Registers a region by name and code.

REQUEST

• URI : http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/<geozone-code>/region?accessToken=<accessToken>
• Method: POST
• Data: JSON

    {
          "name": "<region-name>",
          "code": "<region-code>"
    }

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 201
• Data:

    {
        "name": "<region-name>",
        "code": "<region-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/asia/region?accessToken=xyz123
• Method: POST
• Data : JSON

    {
          "name": "East Asia",
          "code": "asia-east-1"
    }

RESPONSE

• Success: HTTP CODE 201
• Data:

    {
          "name": "East Asia",
          "code": "asia-east-1"
    }

Read Region

Description

Reads a region by code.

REQUEST

• URI : http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/<region-code>?accessToken=<accessToken>
• Method: GET

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    {
        "name": "<region-name>",
        "code": "<region-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/region/asia-east-1?accessToken=xyz123
• Method: GET

RESPONSE

• Success: HTTP CODE 200
• Data:

    {
          "name": "East Asia",
          "code": "asia-east-1"
    }

List Regions

Description

List all registered regions.

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/region?accessToken=<accessToken>
• Method: GET

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "<region-name>",
            "code": "<region-code>"
        }
    ]

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/region?accessToken=xyz123
• Method: GET

RESPONSE

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "East Asia",
            "code": "asia-east-1"
        }
    ]

List Regions of a Geozone

Description

List all registered regions.

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/geozone/<geozone-code>/region?accessToken=<accessToken>
• Method: GET

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "<region-name>",
            "code": "<region-code>"
        }
    ]

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/asia/region?accessToken=xyz123
• Method: GET

RESPONSE

• Success: HTTP CODE 200
• Data:

    [
        {
            "name": "East Asia",
            "code": "asia-east-1"
        }
    ]

Delete Region

Description

Deletes a region by code.

REQUEST

• URI : http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/region/<region-code>?accessToken=<accessToken>
• Method: DELETE

RESPONSE

• Failure: HTTP CODE 400 or 404
• Data:

    {
      "errorMessage": "<error-message-string>",
      "timestamp": <error-timestamp>
    }

• Success: HTTP CODE 200
• Data:

    {
        "name": "<region-name>",
        "code": "<region-code>"
    }

Example

REQUEST

• URI: http://{host}:{port}/streammanager/api/4.0/admin/geoinfo/region/asia-east-1?accessToken=xyz123
• Method: DELETE

RESPONSE

• Success: HTTP CODE 200
• Data:

    {
        "name": "East Asia",
        "code": "asia-east-1"
    }