Todos os produtos
Search

Este produto

    Resource Orchestration Service:DATASOURCE::ApiGateway::Groups

    Central de documentação

    Resource Orchestration Service:DATASOURCE::ApiGateway::Groups

    Última atualização: Jun 27, 2026

    O DATASOURCE::ApiGateway::Groups consulta grupos de API existentes e retorna suas informações básicas.

    Sintaxe

    {
  "Type": "DATASOURCE::ApiGateway::Groups",
  "Properties": {
    "GroupName": String,
    "InstanceId": String,
    "Sort": String,
    "GroupId": String,
    "RefreshOptions": String
  }
}

    Propriedades

    Propriedade

    Tipo

    Obrigatória

    Atualização permitida

    Descrição

    Restrições

    GroupName

    String

    Não

    Sim

    Nome do grupo de API.

    Nenhuma

    InstanceId

    String

    Não

    Sim

    ID da instância.

    Nenhuma

    Sort

    String

    Não

    Sim

    Ordem de classificação.

    Valores válidos:

    • asc: classifica os resultados em ordem crescente por hora de modificação.

    • desc: classifica os resultados em ordem decrescente por hora de modificação.

    GroupId

    String

    Não

    Sim

    ID do grupo de API.

    Nenhuma

    RefreshOptions

    String

    Não

    Sim

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

    Valores válidos:

    • Never (padrão): o recurso da fonte de dados não é atualizado durante a atualização da pilha.

    • Always: o recurso da fonte de dados é sempre atualizado durante a atualização da pilha.

    Dados de retorno (Fn::GetAtt)

    • ApiGroups: lista de grupos de API.

    • ApiGroupIds: lista de IDs de grupos de API.

    Nome da propriedade

    Tipo

    Descrição

    Restrições

    ApiGroupIds

    List

    Lista de IDs de grupos de API.

    Nenhuma

    ApiGroups

    List

    Lista com detalhes dos grupos de API.

    Nenhuma

    BillingStatus

    String

    Status de faturamento.

    Valores válidos:

    • Normal

    • LOCKED: a instância está bloqueada devido a pagamento em atraso.

    GroupId

    String

    ID do grupo de API.

    Nenhuma

    CreatedTime

    String

    Hora de criação.

    A hora está no fuso GMT. O formato é aa-mm-dd-hh-mm.

    Description

    String

    Descrição do grupo.

    Nenhuma

    GroupName

    String

    Nome do grupo de API.

    Nenhuma

    HttpsPolicy

    String

    Política de segurança HTTPS.

    Nenhuma

    IllegalStatus

    String

    Status de bloqueio por atividades ilegais.

    Valores válidos:

    • NORMAL: a instância está normal.

    • LOCKED: a instância está bloqueada devido a atividades ilegais.

    InstanceId

    String

    ID da instância.

    Nenhuma

    InstanceType

    String

    Tipo da instância.

    Nenhuma

    ModifiedTime

    String

    Hora da última modificação.

    A hora está no fuso GMT. O formato é aa-mm-dd-hh-mm.

    RegionId

    String

    Região do grupo de API.

    Nenhuma

    SubDomain

    String

    Domínio de segundo nível atribuído ao grupo de API.

    Usado como CNAME para um nome de domínio personalizado.

    TrafficLimit

    Integer

    Limite máximo de QPS do grupo.

    Valor padrão: 500.

    Nota

    Você pode solicitar o aumento do limite de QPS.

    Tags

    Map

    Tags do grupo de API.

    Nenhuma

    Exemplos

    Formato YAML

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Description: API group ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Groups
    Properties:
      GroupId:
        Ref: GroupId
Outputs:
  ApiGroups:
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroups
  ApiGroupIds:
    Description: The list of ApiGateway group IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroupIds

    Formato JSON

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "API group ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Groups",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGroups": {
      "Description": "The information about ApiGateway groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroups"
        ]
      }
    },
    "ApiGroupIds": {
      "Description": "The list of ApiGateway group IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}