ALIYUN::ApiGateway::Api

语法

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

属性

ErrorCodeSamples语法

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

ErrorCodeSamples属性

ServiceConfig语法

"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属性

VpcConfig语法

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

VpcConfig属性

SystemParameters语法

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

SystemParameters属性

ServiceParameters语法

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

ServiceParameters属性

OpenIdConnectConfig语法

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

OpenIdConnectConfig属性

RequestConfig语法

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

RequestConfig属性

ServiceParametersMap语法

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

ServiceParametersMap属性

RequestParameters语法

"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属性

ConstParameters语法

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

ConstParameters属性

FunctionComputeConfig语法

"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属性

MockHeaders语法

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

MockHeaders属性

返回值

Fn::GetAtt

ApiId：API ID。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RequestConfig": {
      "Type": "Json",
      "Description": "The configuration of the request"
    },
    "Description": {
      "Type": "String",
      "Description": "Description of the API, less than 180 characters."
    },
    "ResultSample": {
      "Type": "String",
      "Description": "The sample of the result."
    },
    "DisableInternet": {
      "Type": "Boolean",
      "Description": "Set DisableInternet to true, only support intranet to call API. \nSet DisableInternet to false, then the call is not restricted. \n",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "ApiName": {
      "Type": "String",
      "Description": "The name of the API.Need [4, 50] Chinese\\English\\Number characters or \"_\",and should start with Chinese/English character."
    },
    "ForceNonceCheck": {
      "Type": "Boolean",
      "Description": "Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when requesting, \nthis is the unique identifier of the request, generally using UUID to identify. \nThe API gateway will verify the validity of this parameter after receiving this parameter. \nThe same value can only be used once within 15 minutes. It can effectively prevent API replay attacks.\nSet ForceNonceCheck to false, then no check. ",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "ResultType": {
      "Type": "String",
      "Description": "The format of service's response, \"JSON\", \"TEXT\", \"BINARY\", \"XML\", \"HTML\" or \"PASSTHROUGH\". Default is \"JSON\".",
      "AllowedValues": [
        "JSON",
        "TEXT",
        "BINARY",
        "XML",
        "HTML",
        "PASSTHROUGH"
      ],
      "Default": "JSON"
    },
    "FailResultSample": {
      "Type": "String",
      "Description": "The sample of the fail result."
    },
    "ErrorCodeSamples": {
      "Type": "Json",
      "Description": "The Error Code samples."
    },
    "GroupId": {
      "Type": "String",
      "Description": "The id of the Group."
    },
    "ServiceParametersMap": {
      "Type": "Json",
      "Description": "The mapping relation between (request parameters\\const parameters\\system parameters) and service parameters."
    },
    "RequestParameters": {
      "Type": "Json",
      "Description": "The request parameters.",
      "Default": []
    },
    "AppCodeAuthType": {
      "Type": "String",
      "Description": "When AuthType is APP authentication, the optional values are as follows: If not passed, the default value is DEFAULT:\nDEFAULT: Default (set by group).\nDISABLE: Not allowed\nHEADER: Allow AppCode header authentication\nHEADER_QUERY: Allow AppCode header and query authentication",
      "AllowedValues": [
        "DEFAULT",
        "DISABLE",
        "HEADER",
        "HEADER_QUERY"
      ]
    },
    "ServiceConfig": {
      "Type": "Json",
      "Description": "The configuration of the service."
    },
    "ConstParameters": {
      "Type": "Json",
      "Description": "The const parameters."
    },
    "SystemParameters": {
      "Type": "Json",
      "Description": "The system parameters."
    },
    "OpenIdConnectConfig": {
      "Type": "Json",
      "Description": "The configuration of the open id."
    },
    "Visibility": {
      "Type": "String",
      "Description": "Whether to make the API public. \"PUBLIC\" or \"PRIVATE\".",
      "AllowedValues": [
        "PUBLIC",
        "PRIVATE"
      ]
    },
    "ServiceParameters": {
      "Type": "Json",
      "Description": "The service parameters."
    },
    "AuthType": {
      "Type": "String",
      "Description": "Type of authorization of the API . \"APP\",\"ANONYMOUS\", or \"APPOPENID\"",
      "AllowedValues": [
        "APP",
        "ANONYMOUS",
        "APPOPENID"
      ]
    }
  },
  "Resources": {
    "API": {
      "Type": "ALIYUN::ApiGateway::Api",
      "Properties": {
        "RequestConfig": {
          "Ref": "RequestConfig"
        },
        "Description": {
          "Ref": "Description"
        },
        "ResultSample": {
          "Ref": "ResultSample"
        },
        "DisableInternet": {
          "Ref": "DisableInternet"
        },
        "ApiName": {
          "Ref": "ApiName"
        },
        "ForceNonceCheck": {
          "Ref": "ForceNonceCheck"
        },
        "ResultType": {
          "Ref": "ResultType"
        },
        "FailResultSample": {
          "Ref": "FailResultSample"
        },
        "ErrorCodeSamples": {
          "Ref": "ErrorCodeSamples"
        },
        "GroupId": {
          "Ref": "GroupId"
        },
        "ServiceParametersMap": {
          "Ref": "ServiceParametersMap"
        },
        "RequestParameters": {
          "Ref": "RequestParameters"
        },
        "AppCodeAuthType": {
          "Ref": "AppCodeAuthType"
        },
        "ServiceConfig": {
          "Ref": "ServiceConfig"
        },
        "ConstParameters": {
          "Ref": "ConstParameters"
        },
        "SystemParameters": {
          "Ref": "SystemParameters"
        },
        "OpenIdConnectConfig": {
          "Ref": "OpenIdConnectConfig"
        },
        "Visibility": {
          "Ref": "Visibility"
        },
        "ServiceParameters": {
          "Ref": "ServiceParameters"
        },
        "AuthType": {
          "Ref": "AuthType"
        }
      }
    }
  },
  "Outputs": {
    "ApiId": {
      "Description": "The id of the API.",
      "Value": {
        "Fn::GetAtt": [
          "API",
          "ApiId"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RequestConfig:
    Type: Json
    Description: The configuration of the request
  Description:
    Type: String
    Description: 'Description of the API, less than 180 characters.'
  ResultSample:
    Type: String
    Description: The sample of the result.
  DisableInternet:
    Type: Boolean
    Description: |
      Set DisableInternet to true, only support intranet to call API. 
      Set DisableInternet to false, then the call is not restricted. 
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  ApiName:
    Type: String
    Description: >-
      The name of the API.Need [4, 50] Chinese\English\Number characters or
      "_",and should start with Chinese/English character.
  ForceNonceCheck:
    Type: Boolean
    Description: >-
      Set ForceNonceCheck to true, compulsorily check X-Ca-Nonce when
      requesting, 

      this is the unique identifier of the request, generally using UUID to
      identify. 

      The API gateway will verify the validity of this parameter after receiving
      this parameter. 

      The same value can only be used once within 15 minutes. It can effectively
      prevent API replay attacks.

      Set ForceNonceCheck to false, then no check. 
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  ResultType:
    Type: String
    Description: >-
      The format of service's response, "JSON", "TEXT", "BINARY", "XML", "HTML"
      or "PASSTHROUGH". Default is "JSON".
    AllowedValues:
      - JSON
      - TEXT
      - BINARY
      - XML
      - HTML
      - PASSTHROUGH
    Default: JSON
  FailResultSample:
    Type: String
    Description: The sample of the fail result.
  ErrorCodeSamples:
    Type: Json
    Description: The Error Code samples.
  GroupId:
    Type: String
    Description: The id of the Group.
  ServiceParametersMap:
    Type: Json
    Description: >-
      The mapping relation between (request parameters\const parameters\system
      parameters) and service parameters.
  RequestParameters:
    Type: Json
    Description: The request parameters.
    Default: []
  AppCodeAuthType:
    Type: String
    Description: >-
      When AuthType is APP authentication, the optional values are as follows:
      If not passed, the default value is DEFAULT:

      DEFAULT: Default (set by group).

      DISABLE: Not allowed

      HEADER: Allow AppCode header authentication

      HEADER_QUERY: Allow AppCode header and query authentication
    AllowedValues:
      - DEFAULT
      - DISABLE
      - HEADER
      - HEADER_QUERY
  ServiceConfig:
    Type: Json
    Description: The configuration of the service.
  ConstParameters:
    Type: Json
    Description: The const parameters.
  SystemParameters:
    Type: Json
    Description: The system parameters.
  OpenIdConnectConfig:
    Type: Json
    Description: The configuration of the open id.
  Visibility:
    Type: String
    Description: Whether to make the API public. "PUBLIC" or "PRIVATE".
    AllowedValues:
      - PUBLIC
      - PRIVATE
  ServiceParameters:
    Type: Json
    Description: The service parameters.
  AuthType:
    Type: String
    Description: 'Type of authorization of the API . "APP","ANONYMOUS", or "APPOPENID"'
    AllowedValues:
      - APP
      - ANONYMOUS
      - APPOPENID
Resources:
  API:
    Type: 'ALIYUN::ApiGateway::Api'
    Properties:
      RequestConfig:
        Ref: RequestConfig
      Description:
        Ref: Description
      ResultSample:
        Ref: ResultSample
      DisableInternet:
        Ref: DisableInternet
      ApiName:
        Ref: ApiName
      ForceNonceCheck:
        Ref: ForceNonceCheck
      ResultType:
        Ref: ResultType
      FailResultSample:
        Ref: FailResultSample
      ErrorCodeSamples:
        Ref: ErrorCodeSamples
      GroupId:
        Ref: GroupId
      ServiceParametersMap:
        Ref: ServiceParametersMap
      RequestParameters:
        Ref: RequestParameters
      AppCodeAuthType:
        Ref: AppCodeAuthType
      ServiceConfig:
        Ref: ServiceConfig
      ConstParameters:
        Ref: ConstParameters
      SystemParameters:
        Ref: SystemParameters
      OpenIdConnectConfig:
        Ref: OpenIdConnectConfig
      Visibility:
        Ref: Visibility
      ServiceParameters:
        Ref: ServiceParameters
      AuthType:
        Ref: AuthType
Outputs:
  ApiId:
    Description: The id of the API.
    Value:
      'Fn::GetAtt':
        - API
        - ApiId