检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
服务商入驻成功后信息还可以修改吗？ 可以，API中心支持您修改服务商信息。具体修改方法，参考变更服务商信息章节。 父主题： 服务商入驻
服务商入驻成功后可以取消入驻吗？ 可以，API中心支持您取消入驻服务商。具体取消方法，参考取消入驻服务商章节。 父主题： 服务商入驻
调试API API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。 后端路径中含有环境变量的API，不支持调试。 如果API已绑定流控策略，在调试API时，流控策略无效。 前提条件 已搭建完成后端服务。 操作步骤 进入API中心服务页面。
签名密钥策略说明 签名密钥用于后端服务验证API网关代理的身份，在API网关代理请求后端服务时，保障后端服务的安全。 签名密钥由一对Key和Secret组成，签名密钥需要绑定到API才能生效。当签名密钥绑定API后，API网关代理向后端服务发送此API的请求时，会增加相应的签名信
HTTP方法不能被用于请求相应的资源如：HTTP方法要求POST方法，请求中使用了GET方法。 406 Not Acceptable 请求资源的内容特性无法满足请求头中的条件。 413 Payload Too Large 请求提交的实体数据大小超过了服务器够处理的范围。 414 URI Too Long 请求的URI长度超过了服务器能够解释的长度。
的跨域头。 非简单请求 对于非简单请求，您需要开启跨域访问，并且创建一个“请求方法”为“OPTIONS”的API。 跨域共享资源策略不需要创建一个“请求方法”为“OPTIONS”的API。 “请求方法”为“OPTIONS”的API和普通API的区别如下： 所属分组：选择已开启CORS的API所在的分组。
仅在API安全认证方式为“APP认证”时，才支持授权给凭据。 单个凭据最多同时授权1000个API。 也可以参考绑定API，将API授权给凭据，与本章所描述方法并无差别。 前提条件 API已发布。 已创建环境。 已创建凭据。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 >
新建分组”链接，新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。 请求方法：GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY，其中ANY表示该API支持任意请求方法。 请求协议：HTTP、HTTPS、HTTP&HTTPS
Id和AppKey用于进行身份认证，该认证方法直接传递密钥，在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证，该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用
凭据定义了一个API调用者的身份。API中心支持将一个API授权给多个凭据，也支持将多个API授权给同一个凭据。 签名密钥 签名密钥由一对Key和Secret组成，用于后端服务验证API网关代理的身份，在API网关代理请求后端服务时，保障后端服务的安全。 当签名密钥绑定API后，API网关代理向后端服务发送此API的
https://{Address}/{Path}?{Query} {Header} { {Body} } POST：请求方法，需替换为获取API的请求信息中获取的请求方法。 {Address}：请求地址，需替换为获取API的请求信息中获取的域名地址。 API网关代理使用分组分配的子域名
401 APIC.0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not
本条规则是Should类型的扩展规则，可提升API的可维护性。 HTTP方法的需要符合幂等性的约束，幂等性的约束是指一次和多次请求某一个资源应该具有同样的副作用，单个资源操作，资源的标准CRUD操作对应的HTTP动词如表1所示。 表1 HTTP动词 方法 描述 幂等性 POST 适用于新建资源场景，以及
访问控制通过设置IP地址或账户的黑白名单来禁止/允许某个IP地址或账户访问API，保护后端服务。 支持区域： 华北-北京四 访问控制策略说明 签名密钥策略 签名密钥用于后端服务验证API网关代理的身份，在API网关代理请求后端服务时，保障后端服务的安全。支持“HMAC”、“Basic Auth”、“Public Key”和“Aes”四种认证类型。
选择授权环境、API分组和API。 单击“确定”。 如需解绑API，在API所在行单击“解绑”即可。 也可以参考授权API章节，将API授权给凭据，与本节所描述方法并无差别。 父主题： API凭据管理
本条规则是Should类型的扩展规则，给API开发者提供灵活的弹性空间。 在API设计过程中，使用POST/PUT请求来避免个人数据被缓存、记录。 HTTP请求方法中，POST请求是向指定的资源提交要被处理的数据，其响应不会被缓存；PUT请求用来提交数据时，其响应是不能被缓存的。 父主题： API生产
源，每一个资源都有唯一的资源标识（resource identifier），对资源的操作不会改变这些标识，所有的操作都是无状态的，使用标准方法操作资源。 RESTful风格的服务接口需定义：操作名、URL、请求和响应消息体和响应状态码。 本文后续章节将分别描述接口各部分的定义规范。
系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTPS”。 子域名：创建API分组时，系统默认分配的一个子域名。
图标 为API资产设置一个图标。如果不设置，则显示默认图标。 资产简介 简单介绍下API资产的行业，用途等。 使用指南 描述API的调用方法。 资产域名 API服务的主机域名或IP，用于API在线调试。 分类 选择API资产所属行业，方便API资产在API中心门户网站按行业类别被搜索。
易于开发者理解。在API参考文档中必须包含如下内容： API目录，包括本次提供API的列表信息。 API名称及API功能介绍。 API请求方法和URI。 API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
