OC/CI/configuration/requests

GET

Returns the requested updates for CDNi configurations. An optional id parameter will return only information for a specific request.

Auth. Required

Yes

Roles Required

“admin”

Permissions Required

CDNI-ADMIN:READ

Response Type

Array

Request Structure

Table 363 Request Query Parameters

Name

Required

Description

id

no

Return only the configuration requests identified by this integral, unique identifier

Response Structure

id

An integral, unique identifier for the requested configuration updates.

ucdn

The name of the uCDN to which the requested changes apply.

data

An array of generic FCI base objects.

host

The domain to which the requested changes apply.

requestType

A string of the type of configuration update request.

asyncStatusId

An integral, unique identifier for the associated asynchronous status.

generic-metadata-type

A string of the type of metadata to follow conforming to RFC 8006.

generic-metadata-value

An array of generic metadata value objects conforming to RFC 8006 and SVA specifications.

footprints

An array of footprints impacted by this generic base object.

Note

These are meant to be generic and therefore there is not much information in these documents. For further information please see RFC 8006, RFC 8007, RFC 8008, and the SVA documents titled Footprint and Capabilities Interface: Open Caching API, Open Caching API Implementation Guidelines, Configuration Interface: Part 1 Specification - Overview & Architecture, Configuration Interface: Part 2 Specification – CDNi Metadata Model Extensions, and Configuration Interface: Part 3 Specification – Publishing Layer APIs.

#862 Example /OC/CI/configuration/requests Response
{
    "response": [
        {
            "id": 1,
            "ucdn": "ucdn1",
            "data": [
                {
                    "generic-metadata-type": "MI.RequestedCapacityLimits",
                    "generic-metadata-value": {
                        "requested-limits": [
                            {
                                "limit-type": "egress",
                                "limit-value": 232323,
                                "footprints": [
                                    {
                                        "footprint-type": "ipv4cidr",
                                        "footprint-value": [
                                            "127.0.0.1",
                                            "127.0.0.2"
                                        ]
                                    },
                                    {
                                        "footprint-type": "countrycode",
                                        "footprint-value": [
                                            "us"
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                }
            ],
            "host": "example.com",
            "requestType": "hostConfigUpdate",
            "asyncStatusId": 0
        }
    ]
}