DocsICP FilingConsole
Documentation
Home Page Resource Orchestration Service Developer Reference Resource Types API Gateway ALIYUN::ApiGateway::Authorization

ALIYUN::ApiGateway::Authorization

Updated at:
Copy as MD
Product
My Favorites

ALIYUN::ApiGateway::Authorization authorizes applications to call APIs.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

ApiIds

List

Yes

Yes

The IDs of the APIs.

You can specify up to 100 IDs.

AppIds

List

Yes

Yes

The IDs of the applications.

System-generated GUID. You can specify multiple IDs.

GroupId

String

Yes

Yes

The ID of the API group.

System-generated GUID.

StageName

String

Yes

Yes

The environment name.

Valid values:

  • TEST

  • PRE

  • RELEASE

AuthValidTime

String

No

Yes

The authorization expiration time.

Must be in UTC.

If empty, the authorization does not expire.

Description

String

No

Yes

The authorization description.

None.

Return values

Fn::GetAtt

None.

Examples

Note

Replace masked parameter values such as GroupId, AppId, and ApiId with actual values.

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Default: 10b1b4dc7a2e6ba8ca3****
    Description: the ID of the API group.
  AppId:
    Type: Number
    Default: 577****
    Description: APP ID
  ApiId:
    Type: String
    Default: 2a8b6d4ce2ad1f95cb****
    Description: API ID
Resources:
  Authorization:
    Type: ALIYUN::ApiGateway::Authorization
    Properties:
      GroupId:
        Ref: GroupId
      StageName: TEST
      AppIds:
        - Ref: AppId
      ApiIds:
        - Ref: ApiId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Default": "10b1b4dc7a2e6ba8ca3****",
      "Description": "the ID of the API group"
    },
    "AppId": {
      "Type": "Number",
      "Default": "577****",
      "Description": "APP ID"
    },
    "ApiId": {
      "Type": "String",
      "Default": "2a8b6d4ce2ad1f95cb****",
      "Description": "API ID"
    }
  },
  "Resources": {
    "Authorization": {
      "Type": "ALIYUN::ApiGateway::Authorization",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        },
        "StageName": "TEST",
        "AppIds": [
          {
            "Ref": "AppId"
          }
        ],
        "ApiIds": [
          {
            "Ref": "ApiId"
          }
        ]
      }
    }
  }
}
Previous：ALIYUN::ApiGateway::AppNext：ALIYUN::ApiGateway::CustomDomain