ConfigId を生成、クエリ、使用する方法 - CDN - Alibaba Cloud ドキュメントセンター

BatchSetCdnDomainConfig または SetCdnDomainStagingConfig を使用してドメイン名に対して機能を設定するたびに、Alibaba Cloud CDN はそのルールに対して一意の設定 ID (ConfigId) を生成します。ConfigId を使用すると、同じ種類の他のルールに影響を与えることなく、特定のルールを更新または削除できます。

一般的なワークフローは次のとおりです。ルールを設定するときに ConfigId を生成し、必要に応じてクエリし、その後、そのルールを更新または削除するために使用します。

API クイックリファレンス

オペレーション	API
設定 ID の生成	BatchSetCdnDomainConfig または SetCdnDomainStagingConfig
設定 ID のクエリ	DescribeCdnDomainConfigs または DescribeCdnDomainStagingConfig
ConfigId を使用した設定の更新	BatchSetCdnDomainConfig または SetCdnDomainStagingConfig
ConfigId を使用した設定の削除	DeleteSpecificConfig または DeleteSpecificStagingConfig

設定 ID の生成

BatchSetCdnDomainConfig または SetCdnDomainStagingConfig を呼び出して、ドメイン名に対して機能を設定します。成功すると、ルールごとに ConfigId が生成されます。

BatchSetCdnDomainConfig ：レスポンスで ConfigId が直接返されます。
SetCdnDomainStagingConfig ：レスポンスで ConfigId は返されません。別途 DescribeCdnDomainStagingConfig を呼び出して取得します。

機能が複数のルールをサポートしている場合、1 回の呼び出しで複数のルールを追加すると、ルールごとに 1 つの ConfigId が返されます。

例：レスポンスヘッダールールを 1 つ追加

example.com に Cache-Control: no-cache を設定し、クライアントに返されるコンテンツをキャッシュしないよう POP (Point of Presence) に指示します。

action: BatchSetCdnDomainConfig
params: {
    "Functions": [{
        "functionArgs": [
            {
                "argName": "value",
                "argValue": "no-cache"
            },
            {
                "argName": "key",
                "argValue": "Cache-Control"
            }
        ],
        "functionName": "set_resp_header"
    }],
    "domainNames": "example.com"
}
product: cdn

成功すると、ConfigId が 1 つ返されます：

{
    "code": "200",
    "data": {
        "DomainConfigList": {
            "DomainConfigModel": [
                {
                    "FunctionName": "set_resp_header",
                    "DomainName": "example.com",
                    "ConfigId": 19571990834****
                }
            ]
        },
        "RequestId": "4FF61A1D-E697-5E6C-9E5D-7D1E1529****"
    },
    "httpStatusCode": "200",
    "requestId": "4FF61A1D-E697-5E6C-9E5D-7D1E1529****",
    "successResponse": true
}

例：複数のレスポンスヘッダールールを一括で追加

example.aliyundoc.com に、2 つの set_resp_header ルールを追加します。1つは Cache-Control: no-cache を設定し、もう1つは Content-Type: text/plain を設定します。

action: BatchSetCdnDomainConfig
params: {
    "domainNames": "example.aliyundoc.com",
    "functions": [
        {
            "functionArgs": [
                {
                    "ArgValue": "Cache-Control",
                    "ArgName": "key"
                },
                {
                    "ArgValue": "no-cache",
                    "ArgName": "value"
                }
            ],
            "functionName": "set_resp_header"
        },
        {
            "functionArgs": [
                {
                    "ArgValue": "Content-Type",
                    "ArgName": "key"
                },
                {
                    "ArgValue": "text/plain",
                    "ArgName": "value"
                }
            ],
            "functionName": "set_resp_header"
        }
    ]
}
product: cdn

成功すると、追加された各ルールに対応する ConfigId が返されます：

{
    "code": "200",
    "data": {
        "DomainConfigList": {
            "DomainConfigModel": [
                {
                    "FunctionName": "set_resp_header",
                    "DomainName": "example.aliyundoc.com",
                    "ConfigId": 20953663204****
                },
                {
                    "FunctionName": "set_resp_header",
                    "DomainName": "example.aliyundoc.com",
                    "ConfigId": 20953663204****
                }
            ]
        },
        "RequestId": "69A79ACE-FD8E-5993-9CEA-7AAB2F08****"
    },
    "httpStatusCode": "200",
    "requestId": "69A79ACE-FD8E-5993-9CEA-7AAB2F08****",
    "successResponse": true
}

設定 ID のクエリ

DescribeCdnDomainConfigs または DescribeCdnDomainStagingConfig を呼び出して、既存ルールの ConfigId を取得します。

例：ドメインの ConfigId のクエリ

example.aliyundoc.com の set_resp_header 設定を照会します：

action: DescribeCdnDomainConfigs
params: {
    "domainName": "example.aliyundoc.com",
    "functionNames": "set_resp_header"
}
product: cdn

レスポンスには、一致した各ルールの ConfigId が含まれます：

{
    "code": "200",
    "data": {
        "RequestId": "51B7DF03-A7AE-56ED-BF1E-D16F6A6B****",
        "DomainConfigs": {
            "DomainConfig": [{
                "Status": "configuring",
                "FunctionName": "set_resp_header",
                "FunctionArgs": {
                    "FunctionArg": [
                        {
                            "ArgValue": "no-cache",
                            "ArgName": "value"
                        },
                        {
                            "ArgValue": "Cache-Control",
                            "ArgName": "key"
                        }
                    ]
                },
                "ConfigId": 19572306654****
            }]
        }
    },
    "httpStatusCode": "200",
    "requestId": "51B7DF03-A7AE-56ED-BF1E-D16F6A6B****",
    "successResponse": true
}

設定 ID を使用した設定の更新

特定のルールを更新するには、BatchSetCdnDomainConfig または SetCdnDomainStagingConfig を呼び出します。function オブジェクトに ConfigId を含めることで、更新対象のルールを指定します。

例：Cache-Control の max-age=3600 への更新

example.com の Cache-Control ヘッダーを no-cache から max-age=3600 に変更して、POP がレスポンスを 1 時間キャッシュするように指示します:

action: BatchSetCdnDomainConfig
params: {
    "Functions": [
        {
            "functionArgs": [
                {
                    "argName": "value",
                    "argValue": "max-age=3600"
                },
                {
                    "argName": "key",
                    "argValue": "Cache-Control"
                }
            ],
            "functionName": "set_resp_header",
            "ConfigId": 19571990834****
        }
    ],
    "domainNames": "example.com"
}
product: cdn

設定 ID を使用した設定の削除

ConfigId を指定して DeleteSpecificConfig または DeleteSpecificStagingConfig を呼び出し、特定のルールを削除します。

例：レスポンスヘッダールールの削除

example.aliyundoc.com 上の ConfigId 19571990834**** のルールを削除します:

action: DeleteSpecificConfig
params: {
    "ConfigId": 19571990834****,
    "domainName": "example.aliyundoc.com"
}
product: cdn