Resource Orchestration Service:ALIYUN::ApiGateway::Api

Syntax

{
  "Type": "ALIYUN::ApiGateway::Api",
  "Properties": {
    "ErrorCodeSamples": List,
    "Description": String,
    "ServiceConfig": Map,
    "SystemParameters": List,
    "ServiceParameters": List,
    "OpenIdConnectConfig": Map,
    "RequestConfig": Map,
    "AuthType": String,
    "Visibility": String,
    "Tags": List,
    "ResultSample": String,
    "ResultType": String,
    "ApiName": String,
    "FailResultSample": String,
    "DisableInternet": Boolean,
    "ForceNonceCheck": Boolean,
    "ConstParameters": List,
    "GroupId": String,
    "ServiceParametersMap": List,
    "RequestParameters": List,
    "AppCodeAuthType": String
  }
}

Properties

Tags syntax

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

Tags properties

ErrorCodeSamples syntax

"ErrorCodeSamples": [
  {
    "Message": String,
    "Code": String,
    "Description": String
  }
]

ErrorCodeSamples properties

ServiceConfig syntax

"ServiceConfig": {
  "ServiceTimeOut": Integer,
  "FunctionComputeConfig": Map,
  "VpcConfig": Map,
  "MockResult": String,
  "MockStatusCode": Integer,
  "ServiceHttpMethod": String,
  "ServiceProtocol": String,
  "ServiceVpcEnable": String,
  "ServiceAddress": String,
  "ContentTypeValue": String,
  "MockHeaders": List,
  "ContentTypeCatagory": String,
  "ServicePath": String,
  "Mock": String
}

ServiceConfig properties

VpcConfig syntax

"VpcConfig": {
  "InstanceId": String,
  "VpcId": String,
  "Port": Integer
}

VpcConfig properties

SystemParameters syntax

"SystemParameters": [
  {
    "DemoValue": String,
    "ParameterName": String,
    "ServiceParameterName": String,
    "Location": String,
    "Description": String
  }
]

SystemParameters properties

ServiceParameters syntax

"ServiceParameters": [
  {
    "ParameterType": String,
    "Location": String,
    "ServiceParameterName": String
  }
]

ServiceParameters properties

OpenIdConnectConfig syntax

"OpenIdConnectConfig": {
  "OpenIdApiType": String,
  "PublicKey": String,
  "PublicKeyId": String,
  "IdTokenParamName": String
}

OpenIdConnectConfig properties

RequestConfig syntax

"RequestConfig": {
  "RequestMode": String,
  "RequestPath": String,
  "PostBodyDescription": String,
  "RequestProtocol": String,
  "RequestHttpMethod": String,
  "BodyFormat": String
}

RequestConfig properties

ServiceParametersMap syntax

"ServiceParametersMap": [
  {
    "RequestParameterName": String,
    "ServiceParameterName": String
  }
]

ServiceParametersMap properties

RequestParameters syntax

"RequestParameters": [
  {
    "ParameterType": String,
    "Required": String,
    "Description": String,
    "DemoValue": String,
    "MinLength": Integer,
    "DefaultValue": String,
    "RegularExpression": String,
    "MaxValue": Integer,
    "MinValue": Integer,
    "JsonScheme": String,
    "ApiParameterName": String,
    "Location": String,
    "DocShow": String,
    "MaxLength": Integer,
    "EnumValue": String,
    "DocOrder": Integer
  }
]

RequestParameters properties

ConstParameters syntax

"ConstParameters": [
  {
    "ConstValue": String,
    "ServiceParameterName": String,
    "Description": String,
    "Location": String
  }
]

ConstParameters properties

FunctionComputeConfig syntax

"FunctionComputeConfig": {
  "FcRegionId": String,
  "RoleArn": String,
  "ServiceName": String,
  "FunctionName": String,
  "Qualifier": String,
  "ContentTypeValue": String,
  "ContentTypeCatagory": String,
  "FcBaseUrl": String,
  "FcType": String,
  "Method": String,
  "OnlyBusinessPath": Boolean,
  "Path": String
}

FunctionComputeConfig properties

MockHeaders syntax

"MockHeaders": [
  {
    "HeaderValue": String,
    "HeaderName": String
  }
]    

MockHeaders properties

Return values

Fn::GetAtt

ApiId: the ID of the API operation.

Examples

• YAMLformat

  ROSTemplateFormatVersion: '2015-09-01'
  Description: Test ApiGateway Api
  Parameters: {}
  Resources:
    RamRole:
      Type: ALIYUN::RAM::Role
      Properties:
        RoleName: TestRole
        Policies:
          - PolicyName: TestPolicy
            PolicyDocument:
              Version: '1'
              Statement:
                - Action:
                    - fc:InvokeFunction
                  Resource:
                    - '*'
                  Effect: Allow
        AssumeRolePolicyDocument:
          Version: '1'
          Statement:
            - Action: sts:AssumeRole
              Effect: Allow
              Principal:
                Service:
                  - apigateway.aliyuncs.com
    FCService:
      Type: ALIYUN::FC::Service
      Properties:
        ServiceName: TestService
        InternetAccess: true
    Function:
      Type: ALIYUN::FC::Function
      DependsOn: FCService
      Properties:
        Handler: index.handler
        Runtime: python3
        Code:
          SourceCode: "def handler(event, context):\n\treturn {'isBase64Encode': False, 'statusCode': 200, 'body': 'Hello World!', 'headers': {'Content-type': 'aplication/json'}}\n"
        FunctionName: mytest
        ServiceName:
          Fn::GetAtt:
            - FCService
            - ServiceName
        MemorySize: 128
    Group:
      Type: ALIYUN::ApiGateway::Group
      Properties:
        InstanceId: api-shared-vpc-001
        GroupName: TestGroup
    Api:
      DependsOn:
        - RamRole
        - Group
      Type: ALIYUN::ApiGateway::Api
      Properties:
        AppCodeAuthType: HEADER_QUERY
        AuthType: APP
        ServiceConfig:
          FunctionComputeConfig:
            fcRegionId:
              Ref: ALIYUN::Region
            qualifier: LATEST
            roleArn:
              Fn::GetAtt:
                - RamRole
                - Arn
            serviceName:
              Fn::GetAtt:
                - FCService
                - ServiceName
            functionName:
              Fn::GetAtt:
                - Function
                - FunctionName
          ServiceProtocol: FunctionCompute
          ContentTypeCatagory: CLIENT
        RequestConfig:
          RequestMode: MAPPING
          RequestHttpMethod: POST
          RequestProtocol: HTTP,HTTPS
          RequestPath: /test
          BodyFormat: FORM
        ResultSample: ''
        Visibility: PRIVATE
        ResultType: JSON
        ApiName: TestApi
        GroupId:
          Fn::GetAtt:
            - Group
            - GroupId
    App:
      Type: ALIYUN::ApiGateway::App
      Properties:
        Description: Test Create App
        AppName: TestApp
  Outputs: {}

• JSONformat

  {
    "ROSTemplateFormatVersion": "2015-09-01",
    "Description": "Test ApiGateway Api",
    "Parameters": {
    },
    "Resources": {
      "RamRole": {
        "Type": "ALIYUN::RAM::Role",
        "Properties": {
          "RoleName": "TestRole",
          "Policies": [
            {
              "PolicyName": "TestPolicy",
              "PolicyDocument": {
                "Version": "1",
                "Statement": [
                  {
                    "Action": [
                      "fc:InvokeFunction"
                    ],
                    "Resource": [
                      "*"
                    ],
                    "Effect": "Allow"
                  }
                ]
              }
            }
          ],
          "AssumeRolePolicyDocument": {
            "Version": "1",
            "Statement": [
              {
                "Action": "sts:AssumeRole",
                "Effect": "Allow",
                "Principal": {
                  "Service": [
                    "apigateway.aliyuncs.com"
                  ]
                }
              }
            ]
          }
        }
      },
      "FCService": {
        "Type": "ALIYUN::FC::Service",
        "Properties": {
          "ServiceName": "TestService",
          "InternetAccess": true
        }
      },
      "Function": {
        "Type": "ALIYUN::FC::Function",
        "DependsOn": "FCService",
        "Properties": {
          "Handler": "index.handler",
          "Runtime": "python3",
          "Code": {
            "SourceCode": "def handler(event, context):\n\treturn {'isBase64Encode': False, 'statusCode': 200, 'body': 'Hello World!', 'headers': {'Content-type': 'aplication/json'}}\n"
          },
          "FunctionName": "mytest",
          "ServiceName": {
            "Fn::GetAtt": [
              "FCService",
              "ServiceName"
            ]
          },
          "MemorySize": 128
        }
      },
      "Group": {
        "Type": "ALIYUN::ApiGateway::Group",
        "Properties": {
          "InstanceId": "api-shared-vpc-001",
          "GroupName": "TestGroup"
        }
      },
      "Api": {
        "DependsOn": [
          "RamRole",
          "Group"
        ],
        "Type": "ALIYUN::ApiGateway::Api",
        "Properties": {
          "AppCodeAuthType": "HEADER_QUERY",
          "AuthType": "APP",
          "ServiceConfig": {
            "FunctionComputeConfig": {
              "fcRegionId": {
                "Ref": "ALIYUN::Region"
              },
              "qualifier": "LATEST",
              "roleArn": {
                "Fn::GetAtt": [
                  "RamRole",
                  "Arn"
                ]
              },
              "serviceName": {
                "Fn::GetAtt": [
                  "FCService",
                  "ServiceName"
                ]
              },
              "functionName": {
                "Fn::GetAtt": [
                  "Function",
                  "FunctionName"
                ]
              }
            },
            "ServiceProtocol": "FunctionCompute",
            "ContentTypeCatagory": "CLIENT"
          },
          "RequestConfig": {
            "RequestMode": "MAPPING",
            "RequestHttpMethod": "POST",
            "RequestProtocol": "HTTP,HTTPS",
            "RequestPath": "/test",
            "BodyFormat": "FORM"
          },
          "ResultSample": "",
          "Visibility": "PRIVATE",
          "ResultType": "JSON",
          "ApiName": "TestApi",
          "GroupId": {
            "Fn::GetAtt": [
              "Group",
              "GroupId"
            ]
          }
        }
      },
      "App": {
        "Type": "ALIYUN::ApiGateway::App",
        "Properties": {
          "Description": "Test Create App",
          "AppName": "TestApp"
        }
      }
    },
    "Outputs": {
    }
  }            

For more examples, visit Api.json and Api.yml. In the examples, the ALIYUN::ApiGateway::Api, ALIYUN::ApiGateway::App, ALIYUN::ApiGateway::Authorization, ALIYUN::ApiGateway::Deployment, ALIYUN::ApiGateway::Signature, ALIYUN::ApiGateway::SignatureBinding, ALIYUN::ApiGateway::TrafficControl, and ALIYUN::ApiGateway::TrafficControlBinding resource types are used.