Learn more:

• Download this API’s RAML and JSON schema descriptors.

Overview

Like China CDN Manager in Akamai Control Center, this API lets you manage the lifecycle and monitor the status of your property hostnames on Akamai’s China CDN. For details on how to get started with the China CDN Manager interface, see the documentation.

The China CDN Manager API offers a programmatic interface that automates how customers create, maintain, and provision property hostnames for use on Akamai’s China CDN platform. Due to Chinese government requirements, the provisioning process involves approval from Akamai’s China partners. The API lets you view the compliance information submitted for this approval.

Due to Chinese government requirements, Akamai’s China partners might begin to request more compliance information to provision your property hostnames. Depending on the particular data collected, this API captures that information and includes it as extra data members in the response.

Get started

To configure this API for the first time:

• Contact your Akamai representative to enable China CDN for your account.

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named China CDN Manager API and set the access level to READ-WRITE.

API concepts

This section provides a guide to the set of resources this API makes available, and provides links to where you can learn more.

• ICP holding entity. An Internet Content Provider (ICP) holding entity is a registered China company you choose to hold a domain for you as a proxy. This API lets you create and manage the holding entity information. List ICP holding entities for details on holding entities available in China.

• ICP number. You use ICP numbers to identify the ICP license issued to the ICP holding entity by the Chinese government. Your property hostname needs to reference the ICP number to deploy it in China. List ICP numbers for the ICP numbers available in China.

• Edge hostname. Each hostname assigned to a property corresponds to an edgeHostname that’s mapped to the deployed property hostname in China. Use Akamai uses DNS to map your end-user requests from the hostname to the edge hostname, then on to the most optimal Akamai edge server. Akamai supports three types of edge hostname, depending on the level of security you need for your traffic: Standard TLS, Enhanced TLS, and Shared Certificate. Use Property Manager or Property Manager API (PAPI) to create a new edge hostname and for guidance on deploying each type. Use the Edge Hostname API (HAPI) to modify edge hostnames or delete any that aren’t referenced by an active property configuration.

• Property hostname. The hostname that you want to deploy on China CDN. You use properties to configure how your content behaves on Akamai’s main edge network. You can assign each property configuration to a set of one or more available edge hostnames. Once assigned, this API lists the set of property hostnames available to deploy on Akamai’s China CDN.

• Group. Within an account, there’s a hierarchy of groups that control access to your property hostnames. You need the group identifier to create a property hostname. Use the Groups interface to find which property hostnames are assigned to existing groups under your account and are available for use on China CDN.

• Provision state. The provisionState member identifies your property hostname’s deployment state and availability to serve your web traffic on China CDN.

• Provision state change. To deploy your property hostname in China and make your web traffic available on a China server, you need to specify how you want the property hostname deployed. This API uses the targetState to initiate your property hostname’s deployment on China CDN. See the Provision state change workflow for details.

• Deprovision policy. The deprovision policy controls how your hostnames are deprovisioned or deactivated if they share an edge hostname. There are two deprovision policies. One unmaps the shared edge hostname from the property hostname before de-whitelisting it. The other doesn’t unmap the shared edge hostname but still de-whitelists the property hostname. If you have selected the deprovision policy that does not unmap the shared edge hostname any deactivation request for an associated property hostname fails. If you have a shared edge hostname make sure to Select the deprovision policy.

• Partner. Local affiliates of China’s Internet service provider who help you obtain an ICP license and compliance with Chinese regulations.

Deployment states

A property hostname’s state identifies its condition during deployment. A property hostname’s status identifies the progress of its provision state change.

When you provision your property hostname on China CDN, you’re requesting approval from Akamai’s China partners to deploy your website on a China server. For example, to begin deploying your website in China, you create a new provision state change and set your property hostname’s targetState object member value to WHITELISTED. The API sends an approval request to the China partners. As the property hostname cycles through the China partners’ approval process, the currentStatus object member changes from PENDING, then to COMPLETED or REJECTED depending on the partners’ approval. After your property hostname is mapped to the provided edge hostname on China CDN, the property hostname’s provisionState object member value is PROVISIONED. This indicates that your website is activated and China CDN is directing your web traffic in China.

Manage property hostnames

This API uses deployment actions to manage your property hostnames lifecycle on China CDN. See the API workflow for details on using these deployment actions:

• Whitelist. Enables your property hostname on China CDN. At this stage, the property hostname isn’t mapped to the provided edge hostname on China CDN. If you want to optimize performance of your web site or application in China, activate your property hostname.

• Activate. If you chose to only whitelist your property hostname when you started the deployment process, and now you want to map the property hostname to improve performance in China, you can activate it to start the mapping process. When mapping completes, the property hostname’s provisionState changes to PROVISIONED.

• Deactivate. If you chose to provision your property hostname and it now appears with the provisioned status, you can choose deactivate it to unmap the property hostname but still keep it whitelisted. You lose the performance benefits of activation, but your property hostname remains available in China. When deactivation completes, the property hostname’s provisionState changes to WHITELISTED.

• Deprovision. If you chose to activate your property hostname and its provisionState is PROVISIONED, you can unmap the property hostname, and remove it from the whitelist. When deprovision completes, the property hostname’s provisionState changes to DEPROVISIONED. If you deprovision a property hostname which is only whitelisted, the API dewhitelists the hostname.

Provision state change workflow

When you create a new provision state change, you specify how you want your property hostname deployed in China. This section describes the different attributes of a property hostname’s provision state change.

• Provision state. The provisionState member identifies your property hostname’s deployment state and availability to serve your web traffic in China.

• Previous state. The previousState member identifies your property hostname’s current deployment state before the targetState change is complete.

• Target State. The targetState member specifies how you want your property hostname deployed in China. For example, setting targetState to PROVISIONED, whitelists your property hostname and maps it to the provided edge hostname on China CDN.

• Pending state. The pendingState member indicates the targetState change is in progress based on the China partners’ approval.

• Partner states. The partnerStates array includes the property hostname’s provisionState and pendingState for the China partner.

• Current status. The currentStatus member indicates the progress of the provision state change. For example, if the China partner approved the targetState change and the system successfully completed the change, the currentStatus value is COMPLETED.

This table describes a property hostname’s typical provision state changes during its deployment lifecycle on China CDN. See the API workflow for additional details.

API workflow

This section summarizes the API’s workflow patterns to manage your property hostnames on China CDN. See the API summary for details on all operations. For details about the data objects the API exchanges, see the Data section.

Before running many of the operations, you need the ICP number identifier. Before creating or updating objects, you also need a relevant property hostnames identifier. The ID values let you access these interfaces:

• Use the List ICP numbers operation if you want to see all ICP numbers under your account.

• Use the List edge hostnames operation if you want to find out if an edge hostname is provided on China CDN.

• Use the List groups operation if you want to find out to which property hostnames existing groups are assigned.

• Use the Property hostnames interface if you want a list of available property hostnames or create or update a property hostname.

Follow these basic workflows to deploy, manage, and maintain your property hostnames on China CDN. To whitelist your property hostname on China CDN:

1. Run the List property hostnames operation for a list of property hostnames under your account.

2. Use the hostname to run the Create a new provision state change operation, which responds with a ProvisionStateChange object.

3. When you build the new ProvisionStateChange object, set the targetState to WHITELISTED, then POST a Create a new provision state change object.

4. The operation responds with a ProvisionStateChange object.

5. To track the property hostname’s currentStatus, Get a provision state change.

To activate your property hostname on China CDN:

1. Run the List property hostnames operation for a list of property hostnames under your account.

2. Use the hostname to run the Create a new provision state change operation, which responds with a ProvisionStateChange object.

3. When you build the new ProvisionStateChange object, set the targetState to PROVISIONED, then POST a Create a new provision state change object.

4. The operation responds with a ProvisionStateChange object.

5. To track the property hostname’s currentStatus, Get a provision state change.

To deactivate your property hostname on China CDN:

1. Run the List property hostnames operation for a list of property hostnames under your account.

2. Use the hostname to run the Create a new provision state change operation, which responds with a ProvisionStateChange object.

3. When you build a new ProvisionStateChange object, set the targetState to WHITELISTED, then POST a Create a new provision state change object.

4. The operation responds with a ProvisionStateChange object.

5. To track the property hostname’s currentStatus, Get a provision state change.

To deprovision your property hostname on China CDN:

1. Run the List property hostnames operation for a list of property hostnames under your account.

2. Use the hostname to run the Create a new provision state change operation, which responds with a ProvisionStateChange object.

3. When you build a new ProvisionStateChange object, set the targetState to DEPROVISIONED, then POST a Create a new provision state change object.

4. To track the property hostname’s currentStatus, Get a provision state change.

Data versioning

When exchanging data, Accept and Content-Type headers need to specify these custom versioned MIME types. Future API releases may provide incremental new versions of objects or remove existing versions of objects as needed. This table shows the most recent version of each object:

Service category types

A service category identifies the type of website you’re deploying in China. When you create a property hostname, the serviceCategoryinteger codes you specify correspond to these:

Business classification types

A business classification identifies the principle function of the ICP holding entity responsible for deploying your web content in China. When you create a property hostname, the businessClassification integer codes you specify correspond to these:

Legal ID types

A legal ID identifies the official documentation of the ICP holding entity. When you Create a property hostname, the legalId integer codes you specify correspond to these:

Resources

This section provides details on the API’s various operations.

API summary

Download the RAML descriptors for this API.

List ICP holding entities

Returns a list of read-only ICP holding entities available under your account. Use this operation to view compliance information for all ICP holding entities.

Accept: application/vnd.akamai.chinacdn.icp-holding-entities.v1+json

Content-Type: application/vnd.akamai.chinacdn.icp-holding-entities.v1+json

{
    "icpHoldingEntities": [
        {
            "id": 1,
            "name": "My Holding Entity 1",
            "businessClassification": 4,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z",
            "legalId": {
                "id": "A23453635",
                "type": 5
            },
            "legalRepresentative": {
                "name": "Fred Smith",
                "phone": "123-456-7890"
            }
        },
        {
            "id": 2,
            "name": "My Holding Entity 2",
            "businessClassification": 4,
            "comments": "N/A",
            "createdBy": "jsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z",
            "legalId": {
                "id": "L23453635",
                "type": 5
            },
            "legalRepresentative": {
                "name": "Joe Smith",
                "phone": "123-555-7890"
            }
        }
    ]
}

List ICP numbers

Returns a list of read-only ICP numbers available under your account. Use this operation to view information about the ICP numbers and to identify the ICP holding entities associated with these ICP numbers.

Accept: application/vnd.akamai.chinacdn.icp-numbers.v1+json

Content-Type: application/vnd.akamai.chinacdn.icp-numbers.v1+json

{
    "icpNumbers": [
        {
            "createdBy": "asmith",
            "createdDate": "2018-01-02T00:00:00.000Z",
            "id": 1,
            "icpNumber": "icpNumber1",
            "icpHoldingEntityId": 1,
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        },
        {
            "createdBy": "asmith",
            "createdDate": "2018-01-02T00:00:00.000Z",
            "id": 2,
            "icpHoldingEntityId": 2,
            "icpNumber": "icpNumber2",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        }
    ]
}

List edge hostnames

Returns a filtered list of provided edge hostnames available for use on a China CDN enabled contract.

Accept: application/vnd.akamai.chinacdn.edge-hostnames.v2+json

Content-Type: application/vnd.akamai.chinacdn.edge-hostnames.v2+json

{
    "edgeHostnames": [
        {
            "edgeHostname": "www.example.com.edgesuite.net",
            "status": "READY",
            "propertyHostnames": 10,
            "unmapSharedEdgeHostname": true
        },
        {
            "edgeHostname": "www.example.com.edgekey.net",
            "status": "NOT_SUPPORTED",
            "propertyHostnames": 0,
            "unmapSharedEdgeHostname": false
        },
        {
            "edgeHostname": "www.example2.com.edgesuite.net",
            "status": "NOT_READY",
            "propertyHostnames": 7,
            "unmapSharedEdgeHostname": true
        }
    ]
}

Get deprovision policy

Returns the deprovision policy for the provided edge hostname.

Accept: application/vnd.akamai.chinacdn.deprovision-policy.v1+json

Content-Type: application/vnd.akamai.chinacdn.deprovision-policy.v1+json

{
    "unmapSharedEdgeHostname": true,
    "createdBy": "asmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

Specify a deprovision policy

Specify a deprovision policy for the provided edge hostname.

Accept: application/vnd.akamai.chinacdn.deprovision-policy.v1+json
Content-Type: application/vnd.akamai.chinacdn.deprovision-policy.v1+json

Content-Type: application/vnd.akamai.chinacdn.deprovision-policy.v1+json

List groups

Returns a filtered list of groups under your account available for use on a China CDN enabled contract.

Accept: application/vnd.akamai.chinacdn.groups.v1+json

{
    "unmapSharedEdgeHostname": true,
    "createdBy": "asmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

Content-Type: application/vnd.akamai.chinacdn.groups.v1+json

{
    "groups": [
        {
            "groupId": 1,
            "groupName": "Group 1"
        },
        {
            "groupId": 2,
            "groupName": "Group 2"
        }
    ]
}

List property hostnames

Returns a list of the property hostnames under your account that are available for deployment on China CDN.

Accept: application/vnd.akamai.chinacdn.property-hostnames.v1+json

Content-Type: application/vnd.akamai.chinacdn.property-hostnames.v1+json

{
    "propertyHostnames": [
        {
            "hostname": "www.example.com",
            "icpNumberId": 456,
            "serviceCategory": 6,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        },
        {
            "hostname": "www.example2.com",
            "icpNumberId": 457,
            "serviceCategory": 13,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        }
    ]
}

Get a property hostname

Returns a specific property hostname under your account.

Accept: application/vnd.akamai.chinacdn.property-hostname.v1+json

Content-Type: application/vnd.akamai.chinacdn.property-hostname.v1+json

{
    "hostname": "www.example.com",
    "icpNumberId": 456,
    "serviceCategory": 13,
    "comments": "N/A",
    "createdBy": "fsmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

Create or update a property hostname

This operation lets you create or update a property hostname based on the group for your current account and contract type. The API responds with a 201 code when you create a new property hostname, and a 200 code thereafter when updating it. If the property hostname has a provision status of WHITELISTED or PROVISIONED and you change the icpNumberId, the API creates a China partner re-approval request. If the partner denies the request for any reason, the property hostname’s provisionState changes to DEPROVISIONED.

Accept: application/vnd.akamai.chinacdn.property-hostname.v1+json
Content-Type: application/vnd.akamai.chinacdn.property-hostname.v1+json

{
    "hostname": "www.example.com",
    "icpNumberId": 456,
    "serviceCategory": 13
}

Content-Type: application/vnd.akamai.chinacdn.property-hostname.v1+json

{
    "hostname": "www.example.com",
    "icpNumberId": 456,
    "serviceCategory": 13,
    "comments": "N/A",
    "createdBy": "fsmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

Content-Type: application/vnd.akamai.chinacdn.property-hostname.v1+json

{
    "hostname": "www.example.com",
    "icpNumberId": 456,
    "serviceCategory": 13,
    "comments": "N/A",
    "createdBy": "fsmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

Create a new provision state change

This operation lets you change your property hostname’s current deployment state. For more information, see the Provision state change workflow, Deployment states, and Manage property hostnames sections.

Accept: application/vnd.akamai.chinacdn.provision-state-changes.v1+json
Content-Type: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

{
    "hostname": "www.example.com",
    "targetState": "PROVISIONED",
    "edgeHostname": "www.example.com.edgesuite.net",
    "sendEmail": true
}

Content-Type: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

{
    "id": 654,
    "hostname": "www.example.com",
    "targetState": "PROVISIONED",
    "previousState": "DEPROVISIONED",
    "edgeHostname": "www.example.com.edgesuite.net",
    "sendEmail": true,
    "currentStatus": "PENDING",
    "createdDate": "2019-07-01T12:32:01Z",
    "completedDate": null,
    "partnerStatuses": {
        "PARTNER1": {
            "targetState": "PROVISIONED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "PENDING",
            "completedDate": null
        },
        "PARTNER2": {
            "targetState": "PROVISIONED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "PENDING",
            "completedDate": null
        }
    }
}

Get a provision state change

Returns details about a specific deployment change for the specified property hostname.

Accept: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

Content-Type: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

{
    "id": 654,
    "hostname": "www.example.com",
    "targetState": "WHITELISTED",
    "previousState": "DEPROVISIONED",
    "edgeHostname": "www.example.com.edgesuite.net",
    "sendEmail": true,
    "currentStatus": "COMPLETED",
    "createdDate": "2019-07-01T12:32:01Z",
    "completedDate": "2019-10-01T17:23:44Z",
    "partnerStatuses": {
        "PARTNER1": {
            "targetState": "WHITELISTED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "COMPLETED",
            "completedDate": "2019-10-01T11:21:32Z"
        },
        "PARTNER2": {
            "targetState": "PROVISIONED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "REJECTED",
            "completedDate": "2019-10-01T17:23:44Z",
            "rejection": {
                "reason": "INVALID_ICP_LICENSE",
                "explanation": "Invalid ICP license."
            }
        }
    }
}

Get the current provision state changes

Returns details about current deployment changes for the specified property hostname under your account.

Accept: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

Content-Type: application/vnd.akamai.chinacdn.provision-state-changes.v1+json

{
    "provisionStateChanges": [
        {
            "id": 654,
            "hostname": "www.example.com",
            "targetState": "WHITELISTED",
            "previousState": "DEPROVISIONED",
            "edgeHostname": "www.example.com.edgesuite.net",
            "sendEmail": true,
            "currentStatus": "COMPLETED",
            "createdDate": "2019-07-01T12:32:01Z",
            "completedDate": "2019-10-01T17:23:44Z",
            "partnerStatuses": {
                "PARTNER1": {
                    "targetState": "WHITELISTED",
                    "previousState": "DEPROVISIONED",
                    "currentStatus": "COMPLETED",
                    "completedDate": "2019-10-01T11:21:32Z"
                },
                "PARTNER2": {
                    "targetState": "PROVISIONED",
                    "previousState": "DEPROVISIONED",
                    "currentStatus": "REJECTED",
                    "completedDate": "2019-10-01T17:23:44Z",
                    "rejection": {
                        "reason": "INVALID_ICP_LICENSE",
                        "explanation": "Invalid ICP license."
                    }
                }
            }
        },
        {
            "id": 655,
            "hostname": "www.example.com",
            "targetState": "WHITELISTED",
            "previousState": "DEPROVISIONED",
            "edgeHostname": "www.example2.com.edgesuite.net",
            "sendEmail": true,
            "currentStatus": "COMPLETED",
            "createdDate": "2019-07-01T12:32:01Z",
            "completedDate": "2019-10-01T17:23:44Z",
            "partnerStatuses": {
                "PARTNER3": {
                    "targetState": "WHITELISTED",
                    "previousState": "DEPROVISIONED",
                    "currentStatus": "COMPLETED",
                    "completedDate": "2019-10-01T11:21:32Z"
                }
            }
        }
    ]
}

List current provision states

Returns a list of current provision states for all property hostnames under your account.

Accept: application/vnd.akamai.chinacdn.provision-states.v1+json

Content-Type: application/vnd.akamai.chinacdn.provision-states.v1+json

{
    "provisionStates": [
        {
            "hostname": "www.example.com",
            "provisionState": "WHITELISTED",
            "pendingState": null,
            "partnerStates": {
                "PARTNER1": {
                    "provisionState": "WHITELISTED",
                    "pendingState": null
                },
                "PARTNER2": {
                    "provisionState": "DEPROVISIONED",
                    "pendingState": "WHITELISTED"
                }
            }
        },
        {
            "hostname": "www.example2.com",
            "provisionState": "WHITELISTED",
            "pendingState": "DEPROVISIONED",
            "partnerStates": {
                "PARTNER1": {
                    "provisionState": "WHITELISTED",
                    "pendingState": "DEPROVISIONED"
                },
                "PARTNER2": {
                    "provisionState": "DEPROVISIONED",
                    "pendingState": null
                }
            }
        }
    ]
}

Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

IcpHoldingEntity

Provides information about the ICP holding entity under your account. This information needs to match the information provided when applying for a license to operate in China. Any mismatch can result in Akamai’s China partner rejecting your request to whitelist a property hostname.

Download schema: icp-holding-entity.json

Sample GET response:

{
    "icpHoldingEntities": [
        {
            "id": 1,
            "name": "My Holding Entity 1",
            "businessClassification": 4,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z",
            "legalId": {
                "id": "A23453635",
                "type": 5
            },
            "legalRepresentative": {
                "name": "Fred Smith",
                "phone": "123-456-7890"
            }
        },
        {
            "id": 2,
            "name": "My Holding Entity 2",
            "businessClassification": 4,
            "comments": "N/A",
            "createdBy": "jsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z",
            "legalId": {
                "id": "L23453635",
                "type": 5
            },
            "legalRepresentative": {
                "name": "Joe Smith",
                "phone": "123-555-7890"
            }
        }
    ]
}

IcpHoldingEntity members

IcpNumber

Provides information about the ICP number used to identify the ICP license issued to the ICP holding entity by the Chinese government. Your property hostname needs to reference the ICP number to deploy it in China. List ICP numbers for the ICP numbers available under your account in China.

Download schema: icp-number.json

Sample GET response:

{
    "icpNumbers": [
        {
            "createdBy": "asmith",
            "createdDate": "2018-01-02T00:00:00.000Z",
            "id": 1,
            "icpNumber": "icpNumber1",
            "icpHoldingEntityId": 1,
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        },
        {
            "createdBy": "asmith",
            "createdDate": "2018-01-02T00:00:00.000Z",
            "id": 2,
            "icpHoldingEntityId": 2,
            "icpNumber": "icpNumber2",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        }
    ]
}

IcpNumber members

EdgeHostname

Provides information about the edge hostnames provided to use on China CDN.

Download schema: edge-hostname-v1.json, edge-hostname-v2.json

Sample GET response:

{
    "edgeHostnames": [
        {
            "edgeHostname": "www.example.com.edgesuite.net",
            "status": "READY",
            "propertyHostnames": 10,
            "unmapSharedEdgeHostname": true
        },
        {
            "edgeHostname": "www.example.com.edgekey.net",
            "status": "NOT_SUPPORTED",
            "propertyHostnames": 0,
            "unmapSharedEdgeHostname": false
        },
        {
            "edgeHostname": "www.example2.com.edgesuite.net",
            "status": "NOT_READY",
            "propertyHostnames": 7,
            "unmapSharedEdgeHostname": true
        }
    ]
}

EdgeHostname members

Group

Provides information about the groups under your account that are available for use on China CDN.

Download schema: group.json

Sample GET response:

{
    "groups": [
        {
            "groupId": 1,
            "groupName": "Group 1"
        },
        {
            "groupId": 2,
            "groupName": "Group 2"
        }
    ]
}

Group members

PropertyHostname

Provides information about the property hostname under your account.

Download schema: property-hostname.json

Sample GET response:

{
    "propertyHostnames": [
        {
            "hostname": "www.example.com",
            "icpNumberId": 456,
            "serviceCategory": 6,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        },
        {
            "hostname": "www.example2.com",
            "icpNumberId": 457,
            "serviceCategory": 13,
            "comments": "N/A",
            "createdBy": "fsmith",
            "createdDate": "2019-07-01T12:32:01Z",
            "updatedBy": "gbarker",
            "updatedDate": "2019-11-02T14:03:01Z"
        }
    ]
}

PropertyHostname members

ProvisionState

Provides information about the current change made to the property hostname’s deployment in China.

Download schema: current-provision-states.json

Sample GET response:

{
    "provisionStates": [
        {
            "hostname": "www.example.com",
            "provisionState": "WHITELISTED",
            "pendingState": null,
            "partnerStates": {
                "PARTNER1": {
                    "provisionState": "WHITELISTED",
                    "pendingState": null
                },
                "PARTNER2": {
                    "provisionState": "DEPROVISIONED",
                    "pendingState": "WHITELISTED"
                }
            }
        },
        {
            "hostname": "www.example2.com",
            "provisionState": "WHITELISTED",
            "pendingState": "DEPROVISIONED",
            "partnerStates": {
                "PARTNER1": {
                    "provisionState": "WHITELISTED",
                    "pendingState": "DEPROVISIONED"
                },
                "PARTNER2": {
                    "provisionState": "DEPROVISIONED",
                    "pendingState": null
                }
            }
        }
    ]
}

ProvisionState members

ProvisionStateChange

Provides information about the change made to the property hostname’s deployment in China.

Download schema: provision-state-change.json

Sample GET response:

{
    "id": 654,
    "hostname": "www.example.com",
    "targetState": "WHITELISTED",
    "previousState": "DEPROVISIONED",
    "edgeHostname": "www.example.com.edgesuite.net",
    "sendEmail": true,
    "currentStatus": "COMPLETED",
    "createdDate": "2019-07-01T12:32:01Z",
    "completedDate": "2019-10-01T17:23:44Z",
    "partnerStatuses": {
        "PARTNER1": {
            "targetState": "WHITELISTED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "COMPLETED",
            "completedDate": "2019-10-01T11:21:32Z"
        },
        "PARTNER2": {
            "targetState": "PROVISIONED",
            "previousState": "DEPROVISIONED",
            "currentStatus": "REJECTED",
            "completedDate": "2019-10-01T17:23:44Z",
            "rejection": {
                "reason": "INVALID_ICP_LICENSE",
                "explanation": "Invalid ICP license."
            }
        }
    }
}

ProvisionStateChange members

DeprovisionPolicy

Contains information about the deprovision policy assigned to the edge hostname.

Download schema: deprovision-policy.json

Sample GET response:

{
    "unmapSharedEdgeHostname": true,
    "createdBy": "asmith",
    "createdDate": "2019-07-01T12:32:01Z",
    "updatedBy": "gbarker",
    "updatedDate": "2019-11-02T14:03:01Z"
}

DeprovisionPolicy members

Errors

This section provides details on the data object that reflects the API’s common response to error cases. It also lists the API’s range of response status codes for both error and success cases.

Error responses

This API responds with JSON objects that adhere to the HTTP Problem Details standard.

This example shows a response with an invalid HTTP method:

{
  "detail": "HTTP method PUT isn't allowed. Allowed methods: [POST].",
  "status": 405,
  "title": "The HTTP method isn't allowed.",
  "type": "/chinacdn/problem-types/method-not-allowed",
  "unsupportedMethod": "PUT",
  "allowedMethods": [
    "POST"
  ]
}

This example shows a response for an unsupported application/json media type. This API uses a system of versioned objects, and the error response shows the available set of media type values you can specify in Accept and Content-Type headers.

{
  "type": "/chinacdn/problem-types/media-type-not-acceptable",
  "title": "Couldn't find acceptable representation.",
  "status": 406,
  "detail": "Couldn't find acceptable representation. Allowed media types: [application/vnd.akamai.chinacdn.property-hostnames.v1+json;charset=UTF-8].",
  "instance": "/chinacdn/problem-types/media-type-not-acceptable?r=-2928080858679738339",
  "unsupportedMediaType": "application/json",
  "allowedMediaTypes": [
    "application/vnd.akamai.chinacdn.property-hostnames.v1+json;charset=UTF-8"
  ]
}

HTTP status codes

This section lists the full range of response codes the API may generate.