{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiDebugInfo":{"properties":{"app_key":{"description":"调试请求使用的APP的key","type":"string"},"app_secret":{"description":"调试请求使用的APP的密钥","type":"string"},"body":{"description":"请求消息体,最长2097152字节","type":"string"},"domain":{"description":"API的访问域名,未提供时根据mode的取值使用如下默认值:\n- DEVELOPER API分组的子域名\n- MARKET 云市场为API分组分配的域名\n- CONSUMER API分组的子域名","type":"string"},"header":{"additionalProperties":{"description":"附加参数","items":{"type":"string"},"type":"array"},"description":"头域参数,每个参数值为字符串数组,每个参数名称有如下约束:\n- 英文字母、数字、点、中连线组成\n- 必须以英文字母开头,最长32字节\n- 不支持以\"X-Apig-\"或\"X-Sdk-\"开头,不区分大小写\n- 不支持取值为\"X-Stage\",不区分大小写\n- mode为MARKET或CONSUMER时,不支持取值为\"X-Auth-Token\"和\"Authorization\",不区分大小写\n> 头域名称在使用前会被规范化,如:\"x-MY-hEaDer\"会被规范化为\"X-My-Header\"","type":"object"},"method":{"description":"API的请求方法","enum":["GET","POST","PUT","DELETE","HEAD","PATCH","OPTIONS"],"type":"string"},"mode":{"description":"调试模式\n- DEVELOPER 调试尚未发布的API定义\n- MARKET 调试云市场已购买的API\n- CONSUMER 调试指定运行环境下的API定义\n> DEVELOPER模式,接口调用者必须是API拥有者。\n\n MARKET模式,接口调用者必须是API购买者或拥有者。\n\n CONSUMER模式,接口调用者必须有API在指定环境上的授权信息或是API拥有者。","type":"string"},"path":{"description":"API的请求路径,需以\"/\"开头,最大长度1024\n> 须符合路径规范,百分号编码格式可被正确解码","type":"string"},"query":{"additionalProperties":{"description":"附加参数","items":{"type":"string"},"type":"array"},"description":"查询参数,每个参数值为字符串数组,每个参数名称有如下约束:\n- 英文字母、数字、点、下划线、中连线组成\n- 必须以英文字母开头,最长32字节\n- 不支持以\"X-Apig-\"或\"X-Sdk-\"开头,不区分大小写\n- 不支持取值为\"X-Stage\",不区分大小写","type":"object"},"scheme":{"description":"API的请求协议\n- HTTP\n- HTTPS","type":"string"},"stage":{"description":"调试请求指定的运行环境,仅在mode为CONSUMER时有效,未提供时有如下默认值:\n- CONSUMER RELEASE","type":"string"}},"required":["mode","path","method","scheme"]},"ApiDebugResp":{"properties":{"latency":{"description":"调试耗时,单位:毫秒","format":"int32","type":"integer"},"log":{"description":"调试过程日志","type":"string"},"request":{"description":"调试请求报文内容","type":"string"},"response":{"description":"调试响应报文内容,响应消息体最大支持2097152字节,超过部分会被截断\n> 响应消息体超过限制长度时,超过部分会被截断,并追加\"[TRUNCATED]\"信息。","type":"string"}}},"ResponseModel":{"properties":{"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误描述","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"025d125ee4da4956af037c3315e94b30","host":"roma.cn-north-4.myhuaweicloud.com","id":"f6465c9fe1634682895cf4e0588ed2be","info_version":"v2","method":"post","name":"DebugApiV2","parameters":{"apic_api_id":{"description":"API的编号","in":"path","name":"api_id","required":true,"type":"string","x-example":"5f918d104dc84480a75166ba99efff21"},"apic_instance_id":{"description":"实例ID","in":"path","name":"instance_id","required":true,"type":"string","x-example":"f0fa1789-3b76-433b-a787-9892951c620e"},"apic_project_id":{"description":"项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。","in":"path","name":"project_id","required":true,"type":"string","x-example":"73d69ae0cfcf460190522d06b60f05ad"},"apic_x_auth_token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXXX..."}},"paths":{"/v2/{project_id}/apic/instances/{instance_id}/apis/debug/{api_id}":{"post":{"description":"调试一个API在指定运行环境下的定义,接口调用者需要具有操作该API的权限。","operationId":"DebugApiV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"$ref":"#/parameters/apic_api_id"},{"description":"调试API请求体","in":"body","name":"DebugApiV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiDebugInfo"}}],"responses":{"200":{"description":"OK","examples":{"application/json":{"latency":5,"log":"","request":"GET /test/mock HTTP/1.1\r\nHost: c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com\r\nUser-Agent: APIGatewayDebugClient/1.0\r\nX-Apig-Mode: debug\r\n\r\n","response":"HTTP/1.1 200 OK\r\nTransfer-Encoding: chunked\r\nConnection: keep-alive\r\nContent-Type: application/json\r\nDate: Mon, 03 Aug 2020 02:51:22 GMT\r\nServer: api-gateway\r\nX-Apig-Latency: 0\r\nX-Apig-Ratelimit-Api: remain:99,limit:100,time:1 minute\r\nX-Apig-Ratelimit-Api-Allenv: remain:14999,limit:15000,time:1 second\r\nX-Request-Id: d4ec6e33148bdeffe8f55b43472d1251\r\n\r\nmock success"}},"schema":{"$ref":"#/definitions/ApiDebugResp"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:mode. Please refer to the support documentation"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"APIG.1002","error_msg":"Incorrect token or token resolution failed"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"403":{"description":"Forbidden","examples":{"application/json":{"error_code":"APIG.1005","error_msg":"No permissions to request this method"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"404":{"description":"Not Found","examples":{"application/json":{"error_code":"APIG.3002","error_msg":"API 3a955b791bd24b1c9cd94c745f8d1aad does not exist"}},"schema":{"$ref":"#/definitions/ResponseModel"}},"500":{"description":"Internal Server Error","examples":{"application/json":{"error_code":"APIG.9999","error_msg":"System error"}},"schema":{"$ref":"#/definitions/ResponseModel"}}},"summary":"调试API","tags":["API管理"],"x-api-version":"v2","x-apigateway-request-type":"public","x-hybridcloud":true,"x-is-registered":"Y","x-open-region-cloud":"hc,hcso","x-order":8,"x-request-examples-1":{"method":"GET","mode":"DEVELOPER","path":"/test/mock","scheme":"HTTPS"},"x-request-examples-description-1":"调试一个未发布的API","x-romaconnect-mode":"huaweicloud,hybrid,on-premise","x-support-sdk":"Y"}}},"product_short":"ROMA","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"调试API","tags":"API管理","uri":null,"version":"2.0"}