查看签名密钥未绑定的API列表
功能介绍
查询所有未绑定到该签名密钥上的API列表。需要API已经发布，未发布的API不予展示。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
|
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
|
sign_id |
是 |
String |
签名密钥编号 |
|
env_id |
否 |
String |
环境编号 |
|
api_id |
否 |
String |
API编号 |
|
api_name |
否 |
String |
API名称 |
|
group_id |
否 |
String |
API分组编号 |
|
tags |
否 |
String |
API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。 最小长度：0 最大长度：128 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
size |
Integer |
本次返回的列表长度 |
|
total |
Long |
满足条件的记录数 |
|
apis |
Array of ApiForSign objects |
本次查询返回的API列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
auth_type |
String |
API的认证方式 |
|
run_env_name |
String |
发布的环境名 |
|
group_name |
String |
API所属分组的名称 |
|
publish_id |
String |
发布记录的编号 |
|
group_id |
String |
API所属分组的编号 |
|
name |
String |
API名称 |
|
remark |
String |
API描述 |
|
run_env_id |
String |
发布的环境id |
|
id |
String |
API编号 |
|
req_uri |
String |
API的请求地址 |
|
tags |
Array of strings |
API绑定的标签，标签配额默认10条，可以联系技术调整。 最小长度：1 最大长度：128 数组长度：0 - 10 |
|
type |
Integer |
API类型 |
|
signature_name |
String |
已绑定的签名密钥名称 |
|
req_method |
String |
API请求方法 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"total" : 1,
"size" : 1,
"apis" : [ {
"run_env_name" : "RELEASE",
"group_name" : "api_group_001",
"remark" : "Mock backend API",
"publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"name" : "Api_mock",
"run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"id" : "3a955b791bd24b1c9cd94c745f8d1aad",
"type" : 1,
"auth_type" : "IAM",
"req_uri" : "/test/mock"
} ]
}
状态码： 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation"
}
状态码： 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
状态码： 404
Not Found
{
"error_code" : "APIG.3017",
"error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
