Help Center/Resource Formation Service/Template Reference/Application Orchestration Service/List of Elements/APIG.ApiGroup
Updated on 2023-08-11 GMT+08:00
View PDF

APIG.ApiGroup

Element Description

An API group is an API management unit. An API group is equivalent to a service entry. When an API group is created, a subdomain name is returned as the access entry.

Element Properties

Table 1 Property Description

Property

Required

Descripiton

remark

No

API group description

Type: string

Value Description: Supports a maximum of 255 characters.

Value Constraint: Supports a maximum of 255 characters.

Suggestion: None

name

Yes

API group name

Type: string

Value Description: Supports customization.

Value Constraint: Supports a string of 3-64 characters. This string consists of Chinese characters, letters, digits, and underscores (_), and starts with a letter.

Suggestion: None

Relationships Between Elements

None.

Return Value

Property

Type

Description

slDomain

string

SL domain

refID

string

API Group UUID

refName

string

API Group name

Blueprint Example

inputs:
  apiName:
    default: api321b
  apigroupName:
    default: test_group321b
  throttleName:
    default: throttle321
node_templates:
  throttle1:
    type: HuaweiCloud.APIG.Throttle
    properties:
      name: 
        get_input: throttleName
      remark: test throttle of aos plugin
      apiCallLimits: 10
      appCallLimits: 7
      userCallLimits: 9
      timeInterval: 100
      timeUnit: MINUTE     
  api-group1:
    properties:
      name:
        get_input: apigroupName
      remark: test group of aos plugin
    type: HuaweiCloud.APIG.ApiGroup
  api1:
    properties:
      authType: NONE
      backendApi:
        remark: test backend
        reqMethod: GET
        reqProtocol: HTTP
        reqUri: '/test/{aaa}'
        timeout: 10000
        urlDomain: 192.145.47.226:12346
      backendType: HTTP
      cors: false
      groupId:
        get_attribute:
          - api-group1
          - refID
      matchMode: NORMAL
      name:
        get_input: apiName
      remark: test api of aos plugin
      reqMethod: GET
      reqProtocol: HTTP
      reqUri: '/test/{aaa}'
      strategyId: 
        get_attribute:
          - throttle1
          - refID
    requirements:
      - groupId:
          node: api-group1
      - strategyId:
          node: throttle1
    type: HuaweiCloud.APIG.API
tosca_definitions_version: huaweicloud_tosca_version_1_0
Parent topic:List of Elements