すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ApiGateway::App

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ApiGateway::App

    最終更新日:Jan 16, 2025

    ALIYUN::ApiGateway::App は、アプリケーションを作成するために使用されます。サードパーティ API を呼び出す前に、アプリケーションを作成し、そのアプリケーションを ID として使用して API を呼び出す必要があります。

    構文

    {
  "Type": "ALIYUN::ApiGateway::App",
  "Properties": {
    "Description": String,
    "Tags": List,
    "AppName": String,
    "AppSecret": String,
    "AppCode": String,
    "AppKey": String
  }
}

    プロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    AppName

    String

    はい

    はい

    アプリケーション名。

    名前はグローバルに一意である必要があります。名前が一意であることを保証するために、特別な識別子を追加することをお勧めします。

    名前は 4 ～ 15 文字で、文字、数字、アンダースコア(_) を使用できます。名前は文字で始める必要があります。

    AppCode

    String

    いいえ

    いいえ

    アプリケーションの AppCode。

    なし。

    AppKey

    String

    いいえ

    いいえ

    アプリケーションのキー。

    キーは API の呼び出しに使用されます。

    AppSecret

    String

    いいえ

    いいえ

    アプリケーションのパスワード。

    なし。

    Description

    String

    いいえ

    はい

    アプリケーションの説明。

    説明は最大 180 文字まで入力できます。

    Tags

    List

    いいえ

    はい

    アプリケーションのタグ。

    アプリケーションには最大 20 個のタグを追加できます。

    タグの構文

    "Tags": [
  {
    "Value": String,
    "Key": String
  }
]

    タグのプロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    Key

    String

    はい

    いいえ

    タグキー。

    タグキーは 1 ～ 128 文字で、http:// または https:// を含めることはできません。タグキーは aliyun または acs: で始めることはできません。

    Value

    String

    いいえ

    いいえ

    タグ値。

    タグ値は最大 128 文字で、http:// または https:// を含めることはできません。タグ値は aliyun または acs: で始めることはできません。

    戻り値

    Fn::GetAtt

    • AppKey: アプリケーションのキー。

    • AppSecret: アプリケーションのシークレット。

    • AppId: アプリケーション ID。

    • Tags: アプリケーションのタグ。

    • AppCode: アプリケーションの AppCode。

    例

    YAML 形式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  APP:
    Type: ALIYUN::ApiGateway::App
    Properties:
      Description: Test Create App
      AppName: DemoApp
Outputs:
  AppId:
    Description: 作成された APP の ID
    Value:
      Fn::GetAtt:
        - APP
        - AppId
  AppKey:
    Description: APP のキー
    Value:
      Fn::GetAtt:
        - APP
        - AppKey
  AppSecret:
    Description: APP のシークレット
    Value:
      Fn::GetAtt:
        - APP
        - AppSecret

    JSON 形式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "APP": {
      "Type": "ALIYUN::ApiGateway::App",
      "Properties": {
        "Description": "Test Create App",
        "AppName": "DemoApp"
      }
    }
  },
  "Outputs": {
    "AppId": {
      "Description": "作成された APP の ID",
      "Value": {
        "Fn::GetAtt": [
          "APP",
          "AppId"
        ]
      }
    },
    "AppKey": {
      "Description": "APP のキー",
      "Value": {
        "Fn::GetAtt": [
          "APP",
          "AppKey"
        ]
      }
    },
    "AppSecret": {
      "Description": "APP のシークレット",
      "Value": {
        "Fn::GetAtt": [
          "APP",
          "AppSecret"
        ]
      }
    }
  }
}