Close CDN Domain Name

Last updated: 2020-06-05 19:59:37

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CDN API 3.0 which is standardized and faster.

    API Description

    This API (OfflineHost) is used to disable the acceleration service for a specified domain name.

    Domain name for API request: cdn.api.qcloud.com

    Notes:

    • Only one CDN domain name can be disabled at a time
    • After the domain name is disabled, a 404 error is returned from CDN node. Make sure that the resolved IP has been moved away from CDN before the domain name is disabled.
    • You can only disable an "Enabled" domain name.
    • The frequency of calling the API is limited to 100/min.

    Input Parameters

    The following request parameter list only provides the API request parameters. Common request parameters are required when the API is called. For more information, please see Common Request Parameters page. The Action field for this API is OfflineHost.

    Parameter Name Required Type Description
    hostId No Int ID of the domain name to be disabled
    host No String Accelerated domain to be disabled

    Notes

    Output Parameters

    Parameter Name Type Description
    code Int Common error code. 0: Successful; other values: Failed.
    For more information, please see Common Error Codes on the Error Codes page.
    message String Module error message description depending on API.
    codeDesc String Error message or error code at business side.
    For more information, please see Business Error Codes on the Error Codes page.

    Example

    Sample Parameters

    hostId: 1234

    GET Request

    For a GET request, all the parameters are required to be appended to the URL:

    https://cdn.api.qcloud.com/v2/index.php?
    Action=OfflineHost
    &SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
    &Timestamp=1462436277
    &Nonce=123456789
    &Signature=XXXXXXXXXXXXXXXXXXXXX
    &hostId=1234

    POST Request

    For a POST request, the parameters are input in HTTP Request-body. The request address is:

    https://cdn.api.qcloud.com/v2/index.php

    Formats such as form-data and x-www-form-urlencoded are supported for the parameters. The array of parameters is as follows:

    array (
      'Action' => 'OfflineHost',
      'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
      'Timestamp' => 1462782282,
      'Nonce' => 123456789,
      'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
      'hostId' => 1234
    )

    Example of Result

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success"
    }
    {
        "code": 4000,
        "message": "(9175) Deploying status cdn host in progress[host in progress]",
        "codeDesc": 9175
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help