すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ApiGateway::Authorization

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ApiGateway::Authorization

    最終更新日:Jan 16, 2025

    ALIYUN::ApiGateway::Authorization は、アプリケーションが API を呼び出すことを承認するために使用されます。

    構文

      {
  "Type": "ALIYUN::ApiGateway::Authorization",
  "Properties": {
    "ApiIds": List,
    "AppIds": List,
    "GroupId": String,
    "StageName": String,
    "Description": String,
    "AuthValidTime": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    ApiIds

    List

    はい

    はい

    API の ID。

    最大 100 個の ID を指定できます。

    AppIds

    List

    はい

    はい

    アプリケーションの ID。

    各 ID は、システムによって生成されるグローバル一意識別子（GUID）です。複数の ID を指定できます。

    GroupId

    String

    はい

    はい

    API グループの ID。

    各 ID は、システムによって生成される GUID です。

    StageName

    String

    はい

    はい

    環境名。

    有効な値：

    • TEST

    • PRE

    • RELEASE

    AuthValidTime

    String

    いいえ

    はい

    承認の有効期限。

    時間は UTC でなければなりません。

    このプロパティを空のままにすると、承認の有効期限は切れなくなります。

    Description

    String

    いいえ

    はい

    承認の説明。

    なし。

    戻り値

    Fn::GetAtt

    なし。

    例

    説明

    GroupId、AppId、ApiId などのマスクされたパラメーターの値は、ビジネス要件に基づいて変更してください。

    YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Default: 10b1b4dc7a2e6ba8ca3****
    Description: API グループの ID。  // the ID of the API group.
  AppId:
    Type: Number
    Default: 577****
    Description: アプリケーション ID // APP ID
  ApiId:
    Type: String
    Default: 2a8b6d4ce2ad1f95cb****
    Description: API ID // API ID
Resources:
  Authorization:
    Type: ALIYUN::ApiGateway::Authorization
    Properties:
      GroupId:
        Ref: GroupId
      StageName: TEST
      AppIds:
        - Ref: AppId
      ApiIds:
        - Ref: ApiId

    JSON 形式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Default": "10b1b4dc7a2e6ba8ca3****",
      "Description": "API グループの ID" // "the ID of the API group"
    },
    "AppId": {
      "Type": "Number",
      "Default": "577****",
      "Description": "アプリケーション ID" // "APP ID"
    },
    "ApiId": {
      "Type": "String",
      "Default": "2a8b6d4ce2ad1f95cb****",
      "Description": "API ID" // "API ID"
    }
  },
  "Resources": {
    "Authorization": {
      "Type": "ALIYUN::ApiGateway::Authorization",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "StageName": "TEST",
        "AppIds": [
          {
            "Ref": "AppId"
          }
        ],
        "ApiIds": [
          {
            "Ref": "ApiId"
          }
        ]
      }
    }
  }
}