Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::ApiGateway::Instances

Última atualização: Jun 27, 2026

O recurso DATASOURCE::ApiGateway::Instances consulta instâncias.

Sintaxe

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

Propriedades

Propriedade

Tipo

Obrigatório

Editável

Descrição

Restrição

Language

String

Não

Sim

Tipo de idioma.

Valores válidos:

  • en: Inglês

  • zh: Chinês

  • ja: Japonês

InstanceId

String

Não

Sim

ID da instância.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos da fonte de dados ao atualizar a pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos da fonte de dados ao atualizar a pilha.

  • Always: atualiza os recursos da fonte de dados ao atualizar a pilha.

Valores de retorno (Fn::GetAtt)

  • ApiGatewayInstances: detalhes das instâncias.

  • ApiGatewayInstanceIds: IDs das instâncias.

Propriedade

Tipo

Descrição

Restrição

ApiGatewayInstanceIds

List

IDs das instâncias.

Nenhuma.

ApiGatewayInstances

List

Detalhes das instâncias.

Nenhuma.

Status

String

Status da instância.

Nenhuma.

InstanceId

String

ID da instância.

Nenhuma.

VpcSlbIntranetEnable

Boolean

Indica se há suporte para instâncias do Server Load Balancer (SLB) do tipo Virtual Private Cloud (VPC).

Valores válidos:

  • true

  • false

ClassicEgressAddress

String

Regra de saída da rede clássica.

Nenhuma.

ZoneLocalName

String

Nome local da zona.

Nenhuma.

VipTypeList

String

Tipo do endereço IP elástico (EIP).

Nenhuma.

UserVpcId

String

ID da VPC associada.

Nenhuma.

VpcIntranetEnable

Boolean

Indica se o acesso à Internet está ativado.

Valores válidos:

  • true

  • false

VpcOwnerId

String

ID da conta proprietária da VPC.

Nenhuma.

InstanceRpsLimit

Integer

Limite de registros por segundo (RPS) da instância.

Nenhuma.

InstanceType

String

Categoria da instância.

Valores válidos:

  • VPC_SHARED: instância compartilhada

  • VPC_DEDICATED: instância dedicada

RegionId

String

ID da região.

Nenhuma.

InstanceSpec

String

Tipo da instância.

Nenhuma.

InstanceChargeType

String

Método de faturamento da instância.

Valores válidos:

  • PrePaid: assinatura

  • PayAsYouGo: pagamento conforme o uso

HttpsPolicies

String

Políticas de segurança HTTPS.

Nenhuma.

VpcEgressAddress

String

Bloco CIDR de saída da VPC.

Nenhuma.

EgressIpv6Enable

Boolean

Indica se há suporte para tráfego IPv6 de saída.

Valores válidos:

  • true

  • false

ExpiredTime

String

Data de expiração da instância.

O horário é exibido em UTC.

InstanceName

String

Nome da instância.

Nenhuma.

ZoneId

String

ID da zona.

Nenhuma.

SupportIpv6

Boolean

Indica se há suporte para IPv6.

Valores válidos:

  • true

  • false

InternetEgressAddress

String

Endereço IP público de saída.

Nenhuma.

CreatedTime

String

Horário de criação da instância.

O horário é exibido em UTC.

UserVswitchId

String

ID do vSwitch associado.

Nenhuma.

InstanceSpecAttributes

List

Especificações da instância.

Nenhuma.

Exemplos

Formato 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"
        ]
      }
    }
  }
}

Formato 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