云服务器内容精选

  • 响应示例 状态码: 200 OK { "total" : 2, "size" : 2, "apis" : [ { "auth_type" : "APP", "run_env_name" : "", "group_name" : "api_group_001", "publish_id" : "", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_function", "remark" : "function API", "run_env_id" : "", "id" : "abd9c4b2ff974888b0ba79be7e6b2763", "req_uri" : "/test/function" }, { "auth_type" : "APP", "run_env_name" : "RELEASE", "group_name" : "APIGroup_d3da", "publish_id" : "ca2631e233a74a758744ae1e19cc5ad7", "group_id" : "6acd94abe58747ee8a73b10c70817bac", "name" : "API_test", "remark" : "function API", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "11cbec3a7a8345ca981b86d161bc436e", "req_uri" : "/appcode" } ] } 状态码: 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.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiOutline objects 本次返回的API列表 表5 ApiOutline 参数 参数类型 描述 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的请求地址 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "auths" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "app_name" : "app_demo", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "envname" : "RELEASE", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_name" : "api_group_001", "api_type" : 1, "api_name" : "Api_http", "appid" : "356de8eb7a8742168586e5daf5339965", "auth_time" : "2020-08-04T04:02:22Z", "app_creator" : "USER", "id" : "dd29b33ae4394e3b924b582c6b40880b", "api_remark" : "Web Api", "auth_role" : "PROVIDER", "app_type" : "apig", "auth_tunnel" : "NORMAL", "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c" } ]} 状态码: 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.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist"} 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 符合条件的API总数 size Integer 本次返回的列表长度 auths Array of V1ApiAuthInfo objects 本次返回的API列表 表5 V1ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型: apig:存量apic客户端,新建实例不支持此类型 roma:roma集成客户端 app_creator String APP的创建者,取值如下: USER:租户自己创建 MARKET:API市场分配,暂不支持 publish_id String API的发布编号 group_id String API绑定的分组ID auth_tunnel String 授权通道类型 NORMAL:普通通道 GREEN:绿色通道 auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_param String 访问参数。 roma_app_type String ROMA_APP的类型: subscription:订阅应用 integration:集成应用 envname String api授权绑定的环境 appid String APP的编号 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述