All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::ApiGateway::Instances

    Document Center

    Resource Orchestration Service:DATASOURCE::ApiGateway::Instances

    Last Updated:Nov 01, 2024

    DATASOURCE::ApiGateway::Instances is used to query instances.

    Syntax

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

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    Language

    String

    No

    Yes

    The language type.

    Valid values:

    • en: English

    • zh: Chinese

    • ja: Japanese

    InstanceId

    String

    No

    Yes

    The instance ID.

    None.

    RefreshOptions

    String

    No

    Yes

    The refresh policy for data source resources when the stack is updated.

    Valid values:

    • Never (default): does not refresh data source resources when the stack is updated.

    • Always: refreshes data source resources when the stack is updated.

    Return values (Fn::GetAtt)

    • ApiGatewayInstances: details of the instances.

    • ApiGatewayInstanceIds: the IDs of the instances.

    Property

    Type

    Description

    Constraint

    ApiGatewayInstanceIds

    List

    The IDs of the instances.

    None.

    ApiGatewayInstances

    List

    Details of the instances.

    None.

    Status

    String

    The status of the instance.

    None.

    InstanceId

    String

    The instance ID.

    None.

    VpcSlbIntranetEnable

    Boolean

    Indicates whether Server Load Balancer (SLB) instances of the virtual private cloud (VPC) type are supported.

    Valid values:

    • true

    • false

    ClassicEgressAddress

    String

    The outbound rule of the classic network.

    None.

    ZoneLocalName

    String

    The local name of the zone.

    None.

    VipTypeList

    String

    The type of the elastic IP address (EIP).

    None.

    UserVpcId

    String

    The ID of the associated VPC.

    None.

    VpcIntranetEnable

    Boolean

    Indicates whether Internet access is enabled.

    Valid values:

    • true

    • false

    VpcOwnerId

    String

    The ID of the account to which the VPC belongs.

    None.

    InstanceRpsLimit

    Integer

    The records per second (RPS) limit on the instance.

    None.

    InstanceType

    String

    The category of the instance.

    Valid values:

    • VPC_SHARED: shared instance

    • VPC_DEDICATED: dedicated instance

    RegionId

    String

    The region ID.

    None.

    InstanceSpec

    String

    The instance type.

    None.

    InstanceChargeType

    String

    The billing method of the instance.

    Valid values:

    • PrePaid: subscription

    • PayAsYouGo: pay-as-you-go

    HttpsPolicies

    String

    The HTTPS security policies.

    None.

    VpcEgressAddress

    String

    The outbound CIDR block of the VPC.

    None.

    EgressIpv6Enable

    Boolean

    Indicates whether outbound IPv6 traffic is supported.

    Valid values:

    • true

    • false

    ExpiredTime

    String

    The expiration time of the instance.

    The time is displayed in UTC.

    InstanceName

    String

    The instance name.

    None.

    ZoneId

    String

    The zone ID.

    None.

    SupportIpv6

    Boolean

    Indicates whether IPv6 is supported.

    Valid values:

    • true

    • false

    InternetEgressAddress

    String

    The outbound public IP address.

    None.

    CreatedTime

    String

    The time when the instance was created.

    The time is displayed in UTC.

    UserVswitchId

    String

    The ID of the associated vSwitch.

    None.

    InstanceSpecAttributes

    List

    The instance specifications.

    None.

    Examples

    JSON format

    {
  "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 format

    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