Use DATASOURCE::ApiGateway::Apis em uma chamada para consultar uma lista de APIs no API Gateway - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Sintaxe

{
  "Type": "DATASOURCE::ApiGateway::Apis",
  "Properties": {
    "EnableTagAuth": Boolean,
    "ApiName": String,
    "Visibility": String,
    "ApiId": String,
    "CatalogId": String,
    "GroupId": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade	Tipo	Obrigatória	Editável	Descrição	Restrição
EnableTagAuth	Boolean	Não	Sim	Indica se a verificação de tags está ativada.	Valores válidos: true false
ApiName	String	Não	Sim	Nome da API.	Suporta correspondência aproximada.
Visibility	String	Não	Sim	Visibilidade da API.	Valores válidos: PUBLIC: Ao definir essa propriedade como PUBLIC, a API torna-se visível na página APIs do console do API Gateway para todos os usuários após a publicação no ambiente de produção. PRIVATE: Ao definir essa propriedade como PRIVATE, a API não é listada no Alibaba Cloud Marketplace, mesmo que o grupo de APIs esteja disponível nele.
ApiId	String	Não	Sim	ID da API.	Nenhuma.
CatalogId	String	Não	Sim	ID da categoria.	Nenhuma.
GroupId	String	Não	Sim	ID do grupo de APIs.	Nenhuma.
RefreshOptions	String	Não	Sim	Política de atualização dos recursos de source de dados durante a atualização da pilha.	Valores válidos: Never (padrão): não atualiza os recursos de source de dados durante a atualização da pilha. Always: atualiza os recursos de source de dados durante a atualização da pilha.

Valores de retorno (Fn::GetAtt)

ApiIds: IDs das APIs.
Apis: detalhes das APIs.

Propriedade	Tipo	Descrição	Restrição
ApiIds	List	IDs das APIs.	Nenhuma.
Apis	List	Detalhes das APIs.	Nenhuma.
Visibility	String	Visibilidade da API.	Valores válidos: PUBLIC PRIVATE
ApiId	String	ID da API.	Nenhuma.
ModifiedTime	String	Hora da última modificação da API.	A hora é exibida em UTC.
Description	String	Descrição da API.	Nenhuma.
GroupName	String	Nome do grupo de APIs.	Nenhuma.
GroupId	String	ID do grupo de APIs.	Nenhuma.
CreatedTime	String	Hora de criação.	A hora é exibida em UTC.
ApiName	String	Nome da API.	Nenhuma.
RegionId	String	ID da região da API.	Nenhuma.

Exemplos

JSON formato

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiId": {
      "Type": "String",
      "Description": "ID of the specified API."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Apis",
      "Properties": {
        "ApiId": {
          "Ref": "ApiId"
        }
      }
    }
  },
  "Outputs": {
    "Apis": {
      "Description": "The information about ApiGateway apis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Apis"
        ]
      }
    },
    "ApiIds": {
      "Description": "The list of The ApiGateway api ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiIds"
        ]
      }
    }
  }
}

YAML formato

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiId:
    Type: String
    Description: ID of the specified API.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Apis
    Properties:
      ApiId:
        Ref: ApiId
Outputs:
  Apis:
    Description: The information about ApiGateway apis.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Apis
  ApiIds:
    Description: The list of The ApiGateway api ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiIds