检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
说明 api_id String 下线成功的API ID api_name String 下线成功的API名称 表7 failure参数说明 名称 类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
查询API概况 功能介绍 查询租户名下的API概况：已发布到RELEASE环境的API个数，未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{pr
status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type
API V1 实例管理类接口 实例使用类接口 其他接口 父主题： 历史API
API管理 创建API 修改API 删除API 发布或下线API 查询API详情 查询API列表 批量发布或下线API 调试API 切换API版本 查看版本详情 根据版本编号下线API 查询API历史版本列表 查询API运行时定义 校验API定义 父主题： 服务集成API
API V1 实例管理类接口 其他接口 父主题： 历史API
如图2所示，单击“订阅”，在弹出的“订阅API”页面，选择新建的应用（例如test001），单击“对象API”，在输入框中输入需要的API（例如createtask），单击“确定”。 图2 订阅API 订阅后的API，在“OpenAPI管理”页面可查看到，如图3所示。 图3 查看API 订阅API后，稍等15分钟，等待订阅生效。
roma_app_name String API归属的集成应用名称 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
丰富的API安全、运维能力。 API测试 通过导入API生成测试用例，快速实现API测试的覆盖。 API消费 ROMA API提供内部市场的能力，将API包装成API产品，支持上架到API目录中，提供完整的API文档展示能力，以及订阅功能。 API分析 提供可视化的API指标数据，方便API管理者进行维护和运营。
API V1 实例管理类接口 其他接口 父主题： 历史API
创建API分组 功能介绍 API分组是API的管理单元，一个API分组等同于一个服务入口，创建API分组时，返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口，请优先使用V2版本接口管理您的API。 URI HT
删除API分组 功能介绍 删除指定的API分组。 删除API分组前，要先下线并删除分组下的所有API。 删除时，会一并删除直接或间接关联到该分组下的所有资源，包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除（取决于域名cname方式）。 URI HTTP
切换API版本 功能介绍 API每次发布时，会基于当前的API定义生成一个版本。版本记录了API发布时的各种定义及状态。 多个版本之间可以进行随意切换。但一个API在一个环境上，只能有一个版本生效。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API E
String API归属的集成应用名称 暂不支持 ld_api_id String 当API的后端为自定义后端时，对应的自定义后端API编号 暂不支持 backend_api BackendApi object web后端详情 api_group_info ApiGroupCommonInfo
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范，API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API：扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/i
创建API 功能介绍 添加一个API，API即一个服务接口，具体的服务能力。API分为两部分，第一部分为面向API使用者的API接口，定义了使用者如何调用这个API。第二部分面向API提供者，由API提供者定义这个API的真实的后端情况，定义了ROMA Connect如何去访问真
创建API分组 操作场景 创建API前，需要先创建API分组。API分组相当于API的集合，API提供者以API分组为单位，管理分组内的所有API。 一个API只能属于某一个API分组。 操作步骤 进入共享版控制台。 单击“开放API > API分组”，进入到API分组信息页面。
取消一个多段上传的任务。 Data+接口 表6 Data+接口 接口 说明 创建工作流 本接口用于直接创建Data+工作流。 查询工作流详情 本接口用于根据工作流名称查询工作流详细信息。 删除工作流 本接口用于标记删除工作流。 更新工作流 本接口用于更新工作流参数值。 查询工作流列表 本接口用于查询工作流列表。
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改，其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/i
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
