API でライブドメインのステージング環境をカナリアテスト用に設定 - LIVE - Alibaba Cloud - ApsaraVideo Live

操作説明

注意事項

CDN ドメイン名を取得してください。その後、この操作を呼び出して、ステージング環境のドメイン名構成を設定または変更できます。詳細については、「関数フォーマットの説明」をご参照ください。

QPS 制限

この操作は、ユーザーごとに秒間クエリ数 (QPS) 30 回に制限されています。この制限を超える API 呼び出しはスロットルされ、ビジネスに影響を与える可能性があります。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:SetLiveDomainStagingConfig

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID です。	cn-shanghai
DomainName	string	必須	CDN ドメイン名です。	developer.aliyundoc.com
Functions	string	必須	機能のリストです。構成を変更する場合のみ ConfigId を指定してください。詳細については、「関数フォーマットの説明」をご参照ください。	[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]

関数フォーマットの説明

構成を設定するには、次の例を参照してください：[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"xxx"}],"functionName":"edge_function"}]
構成を変更するには、Long 型の ConfigId パラメーターを使用して設定項目を指定してください。次の例を参照してください：[{"functionArgs":[{"argName":"enable","argValue":"on"},{"argName":"pri","argValue":"1"},{"argName":"rule","argValue":"yyy"}],"ConfigId":123456,"functionName":"edge_function"}]

注：すべてのパラメーター値は文字列です。

機能名	必須パラメーター	オプションパラメーター
edge_function：エッジルーチン	- rule：DSL ルール- pri：優先度- enable：ルールを有効にするかどうかを指定します。有効値：on、off	- name：ルール名- pos：ルールが実行される位置- brk：現在のルールがヒットした後、現在の実行位置で残りのルールをスキップするかどうかを指定します- option：オプションコントロール- grammar：文法コントロール。有効値：empty、es2、js- jsmode：JavaScript ドメイン名ホワイトリストコントロール。有効値：redirect、bypass

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	04F0F334-1335-436C-A1D7-6C044FE73368

例

成功レスポンス

JSONJSON

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConfigurationConflicts	The staging environment has a configuration in effect. You cannot modify the production environment configuration.
400	InvalidDomain.BelongToConfigGroup	The domain is bound to a configuration group. Modify the domain in the configuration group.
400	InvalidFunctionName.ValueNotSupported	%s, please check and try again later.
400	InvalidArgName.ValueNotSupported	%s, please check and try again later.
400	InvalidArgValue.Malformed	%s, please check and try again later.
400	InvalidRule.Malformed	%s, please check and try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。