Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::APIG::Route

Última atualização: Jun 27, 2026

Consulta os detalhes de uma rota no Cloud-native API Gateway (APIG).

Sintaxe

{
  "Type": "DATASOURCE::APIG::Route",
  "Properties": {
    "HttpApiId": String,
    "RouteId": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

HttpApiId

String

Sim

Sim

ID da API HTTP.

Nenhuma.

RouteId

String

Sim

Sim

ID da rota.

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): não atualiza os recursos da fonte de dados durante a atualização da pilha.

  • Always: atualiza os recursos da fonte de dados durante a atualização da pilha.

Valores de retorno

Fn::GetAtt

  • Backend: serviço de backend.

  • Description: descrição da rota.

  • EnvironmentInfo: informações do ambiente da rota.

  • RouteName: nome da rota.

  • DomainInfos: nomes de domínio associados à rota.

  • RouteId: ID da rota.

  • Match: regra de correspondência da rota.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RouteId:
    Type: String
    Description:
      en: The ID of route resource.
    Required: true
  HttpApiId:
    Type: String
    Description:
      en: The ID of the HTTP API.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::APIG::Route
    Properties:
      RouteId:
        Ref: RouteId
      HttpApiId:
        Ref: HttpApiId
Outputs:
  Backend:
    Description: backend services.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Backend
  Description:
    Description: description of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  EnvironmentInfo:
    Description: environment information.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvironmentInfo
  RouteName:
    Description: The name of the route.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteName
  DomainInfos:
    Description: domain items.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DomainInfos
  RouteId:
    Description: The ID of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - RouteId
  Match:
    Description: the match rule of route resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Match
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RouteId": {
      "Type": "String",
      "Description": {
        "en": "The ID of route resource."
      },
      "Required": true
    },
    "HttpApiId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the HTTP API."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::APIG::Route",
      "Properties": {
        "RouteId": {
          "Ref": "RouteId"
        },
        "HttpApiId": {
          "Ref": "HttpApiId"
        }
      }
    }
  },
  "Outputs": {
    "Backend": {
      "Description": "backend services.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Backend"
        ]
      }
    },
    "Description": {
      "Description": "description of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "EnvironmentInfo": {
      "Description": "environment information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvironmentInfo"
        ]
      }
    },
    "RouteName": {
      "Description": "The name of the route.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteName"
        ]
      }
    },
    "DomainInfos": {
      "Description": "domain items.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DomainInfos"
        ]
      }
    },
    "RouteId": {
      "Description": "The ID of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "RouteId"
        ]
      }
    },
    "Match": {
      "Description": "the match rule of route resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Match"
        ]
      }
    }
  }
}