このドキュメントでは、テンプレート開発者向けのリクエストタイプとリクエストフィールドについて説明します。
テンプレート開発者向けリクエストタイプ
テンプレート開発者は、Resource Orchestration Service (ROS) のリソースALIYUN::ROS::CustomResourceを使用して、テンプレート内のカスタムリソースを指定します。
ALIYUN::ROS::CustomResource には、ServiceToken、Parameters、Timeout の 3 つのプロパティがあります。
プロパティ名 | タイプ | 必須 | 説明 | 制約 |
ServiceToken | String | Yes | カスタムサービスプロバイダーがテンプレート開発者に提供するサービストークンです。 | 現在、FC 関数、SMQ (Simple Message Queue (formerly MNS)) トピック、SMQ (Simple Message Queue (formerly MNS)) キュー、および HTTP & HTTPS がサポートされています。 サービストークンにリージョン制限はありません。 |
Parameters | Map | No | カスタムサービスプロバイダーに渡すパラメータです。カスタムサービスプロバイダーの要件に従ってパラメータを指定します。 | None |
Timeout | Number | No | カスタムサービスプロバイダーからの応答を待機するタイムアウト期間です。 | 範囲:1~43200 単位:秒 デフォルト値:60 |
カスタムリソースプロバイダーのリクエストフィールド
ROS は、JSON リクエストに次のフィールドを含め、カスタムリソースプロバイダーに送信します。
フィールド名 | タイプ | 必須 | 説明 | 制約 |
RequestType | String | Yes | ROS のスタック操作 (スタックの作成、更新、または削除) によって設定されるリクエストタイプです。このスタック操作は、テンプレート開発者がカスタムリソースを含むスタックに対して開始するものです。 | 値:
詳細については、「テンプレート開発者向けリクエストタイプ」をご参照ください。 |
ResponseURL | String | Yes | カスタムリソースプロバイダーから ROS への応答を受信するための、署名付きパブリック URL です。 | None |
IntranetResponseURL | String | Yes | 署名付きの内部ネットワーク URL です。Alibaba Cloud Elastic Compute Service (ECS) インスタンス内でこの URL を使用できます。この URL を介して、カスタムリソースプロバイダーから ROS への応答を受信します。 | None |
StackId | String | Yes | カスタムリソースを含むスタックの ID です。 | None |
StackName | String | Yes | カスタムリソースを含むスタックの名前です。 | None |
ResourceOwnerId | String | Yes | カスタムリソースを含むスタックの所有者の Alibaba Cloud アカウント ID (ルートアカウント) です。 | None |
CallerId | String | Yes | このスタック操作を実行するアカウント (ルートアカウントまたは RAM ユーザー) の ID です。 | None |
RegionId | String | Yes | カスタムリソースを含むスタックのリージョンです。 | None |
RequestId | String | Yes | リクエストの一意の ID です。StackId と RequestId を組み合わせることで、カスタムリソースに対するリクエストを一意に識別できます。 | None |
ResourceType | String | Yes | テンプレート開発者が ROS テンプレートで選択したカスタムリソースのリソースタイプです。 | 最大 68 文字です。文字、数字、アンダースコア (_)、アットマーク (@)、およびハイフン (-) を使用できます。 |
LogicalResourceId | String | Yes | テンプレート開発者が ROS テンプレートで選択したカスタムリソースの名前 (論理 ID) です。これにより、カスタムリソースプロバイダーとテンプレート開発者間の通信が容易になります。 | None |
PhysicalResourceId | String | No | カスタムリソースプロバイダーが定義する物理 ID です。この ID は、そのプロバイダー内で一意です。 | Update リクエストおよび Delete リクエストの場合にのみ使用されます。 |
ResourceProperties | JSON オブジェクト | Yes | リソースのプロパティです。このフィールドには、テンプレート開発者が送信した Properties 内の Parameters オブジェクトの内容が含まれます。内容はカスタムリソースプロバイダーが定義します。 | None |
OldResourceProperties | JSON オブジェクト | No | 更新リクエストの前に指定されていたリソースのプロパティです。 | Update リクエストの場合にのみ使用されます。 |