正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询编排规则绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instan
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息。 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instanc
已购买API 操作场景 API网关共享版支持查看已购买的API,明确已购买服务的详情。并通过调试API,验证服务是否正常。 已购买的API,需要通过APP认证方式调用。 前提条件 已从云商店购买了API。 操作步骤 进入共享版控制台。 单击“调用API > 已购买API”,进入到已购买API分组信息页面。
可用区 选择实例所在的可用区,此处选择“可用区1”。 实例名称 填写实例的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 实例规格 选择实例的容量规格,实例创建后规格不可修改,此处选择“专业版”。 可维护时间窗 选择技术支持对实例进行维护的时间段,建
条件值填写boolean类型时,需全部小写。 定义返回结果。 在“返回结果基础定义”区域,填写返回信息。 表11 定义返回结果 参数 说明 成功响应示例 成功调用API时,返回的响应信息示例。 失败响应示例 调用API失败时,返回的响应信息示例。 单击“完成”,进入“API运行”页面,可查看API详情。
数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample 否 String 正常响应示例,描述API的正常返回信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 r
数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample 否 String 正常响应示例,描述API的正常返回信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 r
长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。
数等信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 result_normal_sample 否 String 正常响应示例,描述API的正常返回信息 字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 r
长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。
支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8 ~ 32字符。 未填写时后台自动生成。 sign_secret
类型 说明 name 是 String 环境的名称 支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "DEVELOP"
修改之后,调用API传入错误的认证信息,返回状态码为401,返回结果如下: 1 {"code":"1001","message":"incorrect username or password","authorizer_success": "false"} 映射后端参数 如果认证通过,函数返回的context信息,可以传到后端,配置方式如下:
类型 说明 name 是 String 环境的名称 支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255。 说明: 中文字符必须为UTF-8或者unicode编码。 请求消息样例: { "name": "DEVELOP"
须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String
支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8 ~ 32字符。 未填写时后台自动生成。 sign_secret
支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8 ~ 32字符。 未填写时后台自动生成。 sign_secret
是否必选 类型 说明 name 是 String 证书名称。 长度为4 ~ 50位的字符串,字符串由中文、英文字母、数字、"_"组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容。 private_key
正常响应示例,描述API的正常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 result_failure_sample String 失败返回示例,描述API的异常返回信息。字符长度不超过20480