添加指定签名密钥与API的绑定(SetSignatureApis)
描述
添加指定签名密钥与API的绑定
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 操作接口名,系统规定参数,取值:SetSignatureApis |
SignatureId | String | 是 | 指定要操作的签名密钥ID。 |
GroupId | String | 是 | 指定要操作API所属分组ID。 |
ApiIds | String | 是 | 指定要操作的API编号,支持输入多个,“,”分隔,最多支持100个 |
StageName | String | 是 | 指定要操作API的环境。
|
名称 | 类型 | 描述 |
RequestId | String | 本次请求编号 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
添加指定签名密钥与API的绑定(SetSignatureApis)
通过调用SetSignatureApis
接口,您可以将特定的签名密钥与一个或多个API进行绑定,以便实现API访问的安全控制。此操作确保只有携带正确签名密钥的请求能够访问这些API,增强了API调用的安全性。
功能描述: - **目的:**为开放API用户提供了将API与特定签名密钥关联的能力,支持批量操作,最大支持同时绑定或解绑100个API。 - **应用场景:**适用于需要精细化管理API访问权限,确保API请求来源合法及数据传输安全的场景。
请求参数: - Action: 必填,固定值SetSignatureApis
,标识此接口的操作类型。 - SignatureId: 是,类型为String,指定要绑定或解绑的签名密钥ID。 - GroupId: 是,类型为String,指定API所属的分组ID。 - ApiIds: 是,类型为String,列出要操作的API编号,多个API间以逗号分隔,最多可指定100个。 - StageName: 是,类型为String,指定要操作API的环境阶段,如RELEASE
(线上)、PRE
(预发)、TEST
(测试)。不传时,默认处理该分组和环境下所有API的绑定关系;若指定,则按列出的环境执行操作,同样支持最多100个环境。
返回参数: - RequestId: String类型,返回本次请求的唯一标识。
示例与说明: 具体请求示例及正常响应详情,请参考知识库中提供的文档资料。其中包含了如何构造请求、预期的响应格式以及错误码查询等实用信息,帮助您快速集成并调试此功能。
请确保在操作前已获取到必要的授权信息,并遵循阿里云API网关的安全策略和最佳实践。