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 Specify a deprovision policy .

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

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 actions:

  • Allowlist. 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.