轻松使用阿里云资源编排,方便你的API管理

本文涉及的产品
资源编排,不限时长
简介: 11月初,阿里云ROS正式发布API 网关(API Gateway)资源,为云计算用户提供高性能、高可用的 API 托管服务,帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用,提供完整的 API 发布、管理、维护生命周期管理。

11月初,阿里云ROS正式发布API 网关(API Gateway)资源,为云计算用户提供高性能、高可用的 API 托管服务,帮助用户对外开放其部署在 ECS、容器服务等阿里云产品上的应用,提供完整的 API 发布、管理、维护生命周期管理。用户只需进行简单的操作,即可快速、低成本、低风险地开放数据或服务。

用户只需要按照自己的需求,根据ROS的模板规范,定义自己的API管理模板,就可以轻轻松松实现API组的创建/更新,API的创建/更新,API的发布或者版本切换,以及API授权,签名,流控等等的配置预更新。

以创建和发布一个新API到测试环境为例。首先用户先根据ROS的模板规范定义自己的模板,模板中会包含下面的几个资源,具体的资源介绍详见帮助文档,
ALIYUN::ApiGateway::Group,
ALIYUN::ApiGateway::API,
ALIYUN::ApiGateway::Deployment

一个最简单的模板定义如下:
{
"ROSTemplateFormatVersion": "2015-09-01",
"Description": "Create an API Gateway",
"Parameters": {

"CustomStage": {
  "Type": "String",
  "Description": "环境",
  "AllowedValues": [
    "TEST",
    "PRE",
    "RELEASE"
  ],
  "Label": "环境",
  "Default": "TEST"
}

},
"Resources": {

"Group": {
  "Type": "ALIYUN::ApiGateway::Group",
  "Properties": {
    "GroupName": "my_api_group",
    "Description": "my api group"
  }
},
"Deployment": {
  "Type": "ALIYUN::ApiGateway::Deployment",
  "Properties": {
    "Description": "liyi_test",
    "StageName": {
      "Ref": "CustomStage"
    },
    "ApiId": {
      "Fn::GetAtt": [
        "API",
        "ApiId"
      ]
    },
    "GroupId": {
      "Fn::GetAtt": [
        "Group",
        "GroupId"
      ]
    }
  }
},
"API": {
  "Type": "ALIYUN::ApiGateway::Api",
  "Properties": {
    "RequestConfig": {
      "RequestPath": "/my_resource",
      "RequestProtocol": "HTTP,HTTPS",
      "RequestHttpMethod": "GET",
      "PostBodyDescription": "k:v",
      "BodyFormat": "FORM"
    },
    "ResultSample": "my_test sample result",
    "ServiceConfig": {
      "ServiceAddress": "http://my_url_site",
      "MockResult": "Nothing",
      "ContentTypeValue": "application/x-www-form-urlencoded; charset=UTF-8",
      "ServiceVpcEnable": "FALSE",
      "ServiceTimeOut": 20000,
      "ServiceProtocol": "HTTP",
      "ServicePath": "/my_data",
      "ServiceHttpMethod": "GET",
          "ContentTypeCatagory": "DEFAULT",
      "Mock": "FALSE"
    },
    "ApiName": "my_test_first_api",
    "Visibility": "PRIVATE",
    "AuthType": "APP",
    "ResultType": "JSON",
    "FailResultSample": "my_test faile sample result",
    "GroupId": {
      "Fn::GetAtt": [
        "Group",
        "GroupId"
      ]
    }
  }
}

},
"Outputs": {

"APIId": {
  "Value": {
    "Fn::GetAtt": [
      "API",
      "ApiId"
    ]
  }
},
"GroupId": {
  "Value": {
    "Fn::GetAtt": [
      "Group",
      "GroupId"
    ]
  }
}

}
}

然后在ROS的控制台(ros.console.aliyun.com)提交你的模板:
进入ROS的控制台如下图所示,然后点击“新建资源栈”按钮。
2

接着会展示新的页面如下,需要在新的页面中选择region,填入上面提供的模板,然后点击“下一步”。
3

紧接着会切换到这个页面,需要再属于一些创建时的参数信息,资源栈的名称,以及你需要在哪个环境发布API。参数设置好之后,点击“创建”按钮。
4

ROS 编排引擎就会根据模板和参数信息,创建API分组,API,并最终发布到测试环境。返回到资源栈管理页面,可以看到如下面的信息,名为“my_api_v1”的资源栈创建成功。
5

点击资源栈名,就可以查看资源栈的相关属性。我们上面的模板中定义了要输出API分组的ID和API 的ID。
6

跳转到API 网关的控制台,就可以看到我们通过模板所创建的API。
7

以上是通过ROS的控制台来创建,发布API。

ROS 当前支持的所有 API 网关的资源类型如下:
ALIYUN::ApiGateway::Group
https://help.aliyun.com/document_detail/61467.html?spm=5176.doc61480.6.650.0oTm2p
创建 API 分组
ALIYUN::ApiGateway::StageConfig::SignatureBinding
https://help.aliyun.com/document_detail/61483.html?spm=5176.doc61482.6.652.43jUI8
创建 API 分组中测试、预发、线上环境变量
ALIYUN::ApiGateway::Api
https://help.aliyun.com/document_detail/61459.html?spm=5176.doc28930.6.645.VIyhF4
创建 API
ALIYUN::ApiGateway::App
https://help.aliyun.com/document_detail/61468.html?spm=5176.doc61459.6.646.jep7UM
创建应用
ALIYUN::ApiGateway::Authorization
https://help.aliyun.com/document_detail/61478.html?spm=5176.doc61468.6.647.wFQfvi
给 API 授权应用的访问权限
ALIYUN::ApiGateway::CustomDomain
https://help.aliyun.com/document_detail/61479.html?spm=5176.doc61478.6.648.O62moc
给 API 分组创建绑定自定义域名
ALIYUN::ApiGateway::Deployment
https://help.aliyun.com/document_detail/61480.html?spm=5176.doc61479.6.649.s0Ltp0
发布 API 或快速切换 API 版
ALIYUN::ApiGateway::Signature
https://help.aliyun.com/document_detail/61482.html?spm=5176.doc61467.6.651.JHTCZz
创建后端签名密钥
ALIYUN::ApiGateway::SignatureBinding
https://help.aliyun.com/document_detail/61483.html?spm=5176.doc61482.6.652.43jUI8
绑定 API 与后端签名密钥
ALIYUN::ApiGateway::TrafficControl
https://help.aliyun.com/document_detail/61485.html?spm=5176.doc61484.6.654.u6Ymvw
创建用户自定义的流控策略
ALIYUN::ApiGateway::TrafficControlBinding
https://help.aliyun.com/document_detail/61488.html?spm=5176.doc61485.6.655.cz94Ob
给 API 绑定用户自定义流控
ALIYUN::ApiGateway::VpcAccessConfig
https://help.aliyun.com/document_detail/61489.html?spm=5176.doc61488.6.656.KXYFQT
配置 VPC 授权以便专有网络的 API 能对外提供服务

ROS也支持openAPI的方式做资源的操作,具体可以参考ROS云栖博客索引
https://yq.aliyun.com/articles/57553?spm=5176.100239.0.0.LzywAe
中的这两篇文章,
1、《阿里云资源编排服务Python SDK使用入门 》
https://yq.aliyun.com/articles/6904?spm=5176.100239.blogcont57553.66.N4yGwL
2、《阿里云资源编排服务Java SDK使用入门》
https://yq.aliyun.com/articles/113503?spm=5176.100239.blogcont57553.67.N4yGwL

同时用户也可以通过ROS的命令行
https://yq.aliyun.com/articles/215216?spm=5176.100239.blogcont57553.72.N4yGwL
工具创建实现资源的创建,更新等等操作。

相关实践学习
使用ROS创建VPC和VSwitch
本场景主要介绍如何利用阿里云资源编排服务,定义资源编排模板,实现自动化创建阿里云专有网络和交换机。
阿里云资源编排ROS使用教程
资源编排(Resource Orchestration)是一种简单易用的云计算资源管理和自动化运维服务。用户通过模板描述多个云计算资源的依赖关系、配置等,并自动完成所有资源的创建和配置,以达到自动化部署、运维等目的。编排模板同时也是一种标准化的资源和应用交付方式,并且可以随时编辑修改,使基础设施即代码(Infrastructure as Code)成为可能。 产品详情:https://www.aliyun.com/product/ros/
相关文章
|
1天前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 云原生 API 网关 2024 年 08 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要
|
10天前
|
Cloud Native 关系型数据库 Serverless
基于阿里云函数计算(FC)x 云原生 API 网关构建生产级别 LLM Chat 应用方案最佳实践
本文带大家了解一下如何使用阿里云Serverless计算产品函数计算构建生产级别的LLM Chat应用。该最佳实践会指导大家基于开源WebChat组件LobeChat和阿里云函数计算(FC)构建企业生产级别LLM Chat应用。实现同一个WebChat中既可以支持自定义的Agent,也支持基于Ollama部署的开源模型场景。
|
30天前
|
API
阿里云微服务引擎及 API 网关 2024 年 7 月产品动态
阿里云微服务引擎及 API 网关 2024 年 7 月产品动态。
|
1月前
|
人工智能 Cloud Native 安全
统一多层网关好处多,阿里云云原生 API 网关打造全能型网关
本文分享了作为一款全能型网关【云原生 API 网关】是如何帮助企业落地统一网关架构的。
7696 7
|
28天前
|
弹性计算 API 开发工具
揭秘Python与阿里云API的神秘邂逅!流式处理的魔法之旅,一场颠覆想象的技术盛宴!
【8月更文挑战第15天】在数字世界的广阔舞台上,Python与阿里云API的相遇,就像是一场命中注定的邂逅。它们携手共舞,为我们带来了流式处理的魔法之旅。本文将揭开这场神秘邂逅的面纱,带你领略Python与阿里云API之间的奇妙互动。让我们一起踏上这场颠覆想象的技术盛宴,探索流式处理的无限可能!
69 7
|
24天前
|
运维 Devops API
阿里云云效操作报错合集之调用api报错:没有权限,是什么原因
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
|
27天前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 API 网关 2024 年 07 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要。
|
2月前
|
JSON Shell API
阿里云PAI-Stable Diffusion开源代码浅析之所有api的入参如何看
阿里云PAI-Stable Diffusion开源代码浅析之所有api的入参如何看
|
24天前
|
敏捷开发 测试技术 API
阿里云云效产品使用合集之调用API次数过多导致限流,该怎么办
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。
|
24天前
|
运维 API 开发工具
阿里云云效操作报错合集之在编辑器里api接口调用时,经常报错,是什么原因
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。

推荐镜像

更多