获取API信息

最近更新时间:2020-08-21 11:17:43

查看PDF

获取API信息(GetInfoApi)

描述

获取API信息

HTTP METHOD

GET | POST

请求参数

公共参数列表 详情

名称 类型 必填 长度限制(字符) 参数格式 描述
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值: GetInfoApi
Version String 确定值 固定为:2019-05-01
ApiUuid String 22个字符 [a-zA-Z0-9-_]+ API UUID
返回结果

通过指定 Accept:application/json,返回的数据格式为json

示例(调用成功)
请求示例
curl -X GET|POST \
'http://apigw.api.ksyun.com/?Action=GetInfoApi&Version=2019-05-01&ApiUuid=y49y2Ab6TJaqW7EWemnD8Q' \
-H 'authorization: xxx, SignedHeaders=accept;content-type;host;x-amz-date, Signature=xxx' \
-H 'accept: application/json' \
-H 'content-type: application/x-www-form-urlencoded' \
-H 'host: apigw.api.ksyun.com' \
-H 'x-amz-date: 20170720T022802Z'
响应成功返回示例
{
    "Res": {
        "id": 252,
        "account_id": "2000091140",
        "api_group_id": 316,
        "api_group_uuid": "e799f912300ce953d11ccdd107305e2f",
        "api_name": "Ksyun",
        "api_uuid": "y49y2Ab6TJaqW7EWemnD8Q",
        "api_desc": "Ksyun Desc",
        "is_valid": 1,
        "type": 1,
        "front_auth_type": 1,
        "backend_auth_type": 1,
        "front_req_type": 3,
        "backend_service_type": 1,
        "api_base_info": "{\"api_name\":\"Ksyun\",\"api_desc\":\"Ksyun Desc\",\"api_group_uuid\":\"e799f912300ce953d11ccdd107305e2f\",\"type\":1,\"front_auth_type\":1,\"backend_auth_type\":1,\"front_req_type\":3,\"backend_service_type\":1}",
        "api_req_info": "{\"domain\":\"e799f912300ce953d11ccdd107305e2f.cn-beijing-6.kscloudapi.com\",\"req_protocol\":3,\"req_uri\":\"\\/info1\",\"path_match_mode\":1,\"req_method\":\"GET\",\"is_cors\":0,\"req_params\":[],\"is_not_w_form\":0,\"content\":\"\",\"model_uuid\":null}",
        "api_backend_info": "{\"req_protocol\":\"http\",\"service_type\":1,\"const_params\":[],\"sys_params\":[],\"backend_params\":[],\"req_address\":\"test1.com\",\"address_type\":1,\"req_path\":\"\\/getUserInfo\",\"req_method\":\"GET\",\"backend_auth_type\":1,\"connect_timeout\":\"1000\",\"read_timeout\":\"3000\"}",
        "api_resp_info": "{\"success\":\"{\\n}\",\"failed\":\"{\\n}\",\"error_code\":[]}",
        "dev_run_version": "",
        "pre_release_run_version": "",
        "release_run_version": "20200819183114-0.57133400",
        "deleted": 0,
        "create_time": 1597832981,
        "update_time": 1597833237,
        "deleted_time": 0,
        "api_group_name": "Ksyun"
    },
    "RequestId": "b64f5046-0697-48e0-9432-374607bd5f6e"
}

访问API错误码查看更多错误码

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈