检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
PI网关提供默认的网关响应(default),如果您需要自定义响应状态码或网关响应内容,可在API分组管理中新增网关响应,其中响应内容符合JSON格式即可。 例如,“default”网关的响应内容为: {"error_code": "$context.error.code", "error_msg":
apiId"} JSON体的内容可以按需定制,包括增减字段内容。 API提供的默认网关响应“default”也可以编辑修改。 您可以新增多个网关响应,支持同一分组下不同API配置不同的网关响应内容。 网关响应所定义的错误类型固定且不可修改,具体见网关错误响应类型说明。 响应内容支持调用API网
服务。 访问控制 访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 调试API 验证API服务的功能是否正常可用。 发布API
APP管理(待下线) 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 父主题: 专享版API(V1)(待下线)
简易认证指调用API时,在HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填应用详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启了简易认证模式,API请求既可以选择使
APP管理 对象模型 创建APP 修改APP 重置密钥 删除APP 校验APP 查看APP详情 查询APP列表 创建App Code 自动生成App Code 查看App Code详情 查询App Code列表 删除App Code 父主题: 共享版API(仅存量用户使用)
"city02" ] } } 响应消息 表4 参数说明 参数 类型 说明 request String 调试请求报文内容 response String 调试响应报文内容,响应消息体最大支持2097152字节,超过部分会被截断 说明: 响应消息体超过限制长度时,超过部分会被截断,并追加"[TRUNCATED]"信息。
共享版操作指导(仅存量用户使用) APIG使用流程 进入共享版控制台 API分组管理 API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
x-apigateway-content-type 含义: API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json
专享版-凭据管理 创建APP 修改APP 删除APP 重置密钥 校验APP 查看APP详情 查询APP列表 创建APP Code 自动生成APP Code 删除APP Code 查看APP Code详情 查询APP Code列表 查询凭据关联的凭据配额 设置APP的访问控制 查看APP的访问控制详情
简易认证指在调用API时,HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。 当使用APP认证,且开启了简易认证模式,API请求既可以选择使
"city02" ] } } 响应消息 表4 参数说明 参数 类型 说明 request String 调试请求报文内容 response String 调试响应报文内容,响应消息体最大支持2097152字节,超过部分会被截断 说明: 响应消息体超过限制长度时,超过部分会被截断,并追加"[TRUNCATED]"信息。
支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。
ssl_infos Array of SslInfo objects SSL证书列表。 表20 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号。 ssl_name String SSL证书名称。 algorithm_type String 证书算法类型:
3:已删除 默认1 该字段已废弃 R - appkey String APP的key,全局唯一 R - app_secret String 密钥 RU - project_id String APP所属租户编号,即APP的创建者 - - remark String 描述 CRU 否
3:已删除 默认1 该字段已废弃 R - appkey String APP的key,全局唯一 R - app_secret String 密钥 RU - project_id String APP所属租户编号,即APP的创建者 - - remark String 描述 CRU 否
支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。
支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。
支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。
ID)/SK(Secret Access Key)和API网关提供的SDK,对API请求进行签名处理。 后端服务签名校验开发:若API在API网关上绑定了签名密钥,则API网关向该API的后端服务发送请求时会携带相应的签名信息。该API的后端服务需要集成API网关提供的SDK,并对请求中的签名信息进行校验。