检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
编辑测试步骤,填写请求信息、请求头和请求体。 如果URL中存在调试域名(创建API服务时,自动生成),请将调试域名更改为实例的弹性IP地址,并且header中需添加参数host,值为调试域名。 单击执行测试。 若执行失败,可单击“查看结果”,查看日志定位原因。 更多详细操作,请参考快速入门。 父主题: API管理
流水线执行成功后,单击“克隆/下载”下载流水线的jar包,将包部署到自己的服务器上。 步骤五:创建API服务 单击“导入到API服务”。 导入前,对API文件进行导入规则检查。 需修复问题,请单击“修复问题”,根据“API Rule Check”提示修改。 无问题修复,请单击“继续导入”。 选择步骤一中实例,填写服务名称,并选择API接口。
在页面上单击服务名称,进入API服务详情页面。 在“网关响应”区域,即可新增或编辑网关响应。 如果修改完默认网关响应后,需要恢复默认配置,单击“恢复默认配置”即可。 不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信
重置Secret 在“凭证信息”区域,凭证“Key”和“Secret”是创建凭证后自动生成的,如需修改密码,单击“重置Secret”重置即可。注意重置后无法恢复,请谨慎操作。 编辑凭证 如需修改凭证信息,单击“编辑凭证”即可。 删除凭证 如需删除凭证信息,单击“删除凭证”即可。 取消订阅
API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA
必须采用“%XY%ZA%BC”格式。 对于每个参数,追加“URI编码的参数名称=URI编码的参数值”。如果没有参数值,则以空字符串代替,但不能省略“=”。 例如以下含有两个参数,其中第二个参数parm2的值为空。 parm1=value1&parm2= 按照字符代码以升序顺序对参
单击编辑窗口上方的“规范性检查”。 在可视化窗口单击“Show”查看结果,您可以根据“修改建议”修改规范性问题。 (可选)单击“表单”页签。 单击页面右上角“规范性检查”。 在弹窗中查看结果,您可以根据“修改建议”修改规范性问题。 创建Tag 对API接口进行分类处理,方便筛选或查找API接口。
例和API服务,勾选API。 只有已部署到RELEASE环境中的API,才能被添加到API产品中。 每个API仅能被添加到一个API产品,无法同时添加到多个产品中。 单击“立即创建”,创建API产品。 如需添加API到产品,请参考添加API到产品。 添加API到产品 登录ROMA
错误码 用户在调用API失败时,系统返回的错误码包含ROMA和APIG的错误码: 在ROMA实例下,系统返回的错误码请参考错误码。 在APIG实例下,系统返回的错误码请参考错误码。 父主题: 调用API
单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。 授权API 仅使用APP认证方式的API,才需要授权,发布API后,通
选择解压后php的SDK路径 完成工程创建后,目录结构如下。 图4 新建工程php的目录结构 “signer.php”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在代码中引入sdk。 1 require 'signer.php'; 生成一个新的Signer,
API。 作为中级使用者,在创建API服务时,您可以把服务部署到环境上,同时间接地发布API。 已发布到环境的API,在修改配置信息后,需要重新发布才能将修改后的信息同步到环境中。 前提条件 系统已提供了默认发布环境RELEASE,如果您需要把API发布到其他环境,请提前创建环境。
API产品”。 选择待申请的产品,单击产品名称。 选择待申请的版本,单击“上架/不推荐/下架”,填写申请。 已上架的产品修改产品信息后需要提交申请,审核通过后才能修改成功。 单击“确定”,并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。
策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
在“已启用”的规则中,勾选需要取消启用的规则,单击“取消启用”。 启用规则 在“未启用”的规则中,勾选需要启用的规则,单击“启用”。 编辑:修改规则集名称和描述。 创建规则集 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删除的证书,单击所在行的“删除”,即可删除证书。 父主题:
操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。 删除自定义认证 删除不需要的自定义认证。 找到需要删除的自定义认证,单击所在行的“删除”,即可删除自定义认证。
参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次更新时间。若参数从未修改过,该更新时间为空。 表2 实例配置参数说明 参数名 参数说明 ratelimit_api_limits API全局默认流控值。API未绑
在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时,返回HTTP状态码为“200”和Response信息。 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参考错误码。 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作