全部產品
Search
文件中心

Resource Orchestration Service:DATASOURCE::ApiGateway::Instances

更新時間:Sep 19, 2024

DATASOURCE::ApiGateway::Instances類型用於查詢執行個體列表。

文法

{
  "Type": "DATASOURCE::ApiGateway::Instances",
  "Properties": {
    "Language": String,
    "InstanceId": String,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

Language

String

語言類型。

取值:

  • en:英文。

  • zh:中文。

  • ja:日文。

InstanceId

String

執行個體ID。

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

有效值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

返回資料(Fn::GetAtt)

  • ApiGatewayInstances:執行個體詳情列表。

  • ApiGatewayInstanceIds:執行個體ID列表。

屬性名稱

類型

描述

約束

ApiGatewayInstanceIds

List

執行個體ID列表。

ApiGatewayInstances

List

執行個體詳情列表。

Status

String

執行個體狀態。

InstanceId

String

執行個體ID。

VpcSlbIntranetEnable

Boolean

是否支援VPC類型SLB。

取值:

  • true:支援。

  • false:不支援。

ClassicEgressAddress

String

傳統網路出方向訪問規則。

ZoneLocalName

String

可用性區域域。

VipTypeList

String

Elastic IP Address類型。

UserVpcId

String

綁定的專用網路ID。

VpcIntranetEnable

Boolean

是否開啟公網。

取值:

  • true:開啟公網。

  • false:關閉公網。

VpcOwnerId

String

專用網路所屬帳號ID。

InstanceRpsLimit

Integer

執行個體Rps限制。

InstanceType

String

執行個體類型。

取值:

  • VPC_SHARED:共用執行個體。

  • VPC_DEDICATED:專享執行個體。

RegionId

String

所在的地區。

InstanceSpec

String

執行個體規格。

InstanceChargeType

String

執行個體的計費方式。

取值:

  • PrePaid:訂用帳戶。

  • PayAsYouGo:隨用隨付。

HttpsPolicies

String

HTTPS安全性原則。

VpcEgressAddress

String

內網VPC出口網段。

EgressIpv6Enable

Boolean

是否支援IPv6出訪能力。

取值:

  • true:支援IPv6出訪能力。

  • false:不支援IPv6出訪能力。

ExpiredTime

String

執行個體到期時間。

格林威治時間。

InstanceName

String

執行個體名稱。

ZoneId

String

可用性區域ID。

SupportIpv6

Boolean

是否支援IPv6。

取值:

  • true:支援IPv6。

  • false:不支援IPv6。

InternetEgressAddress

String

公網出口地址。

CreatedTime

String

執行個體建立時間。

格林威治時間。

UserVswitchId

String

綁定的虛擬交換器ID。

InstanceSpecAttributes

List

執行個體規格。

樣本

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "API Gateway Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Instances",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGatewayInstances": {
      "Description": "The information about ApiGateway groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstances"
        ]
      }
    },
    "ApiGatewayInstanceIds": {
      "Description": "The list of The ApiGateway group ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGatewayInstanceIds"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: API Gateway Instance ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Instances
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  ApiGatewayInstances:
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstances
  ApiGatewayInstanceIds:
    Description: The list of The ApiGateway group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGatewayInstanceIds