{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ApiActionInfo":{"properties":{"action":{"description":"需要进行的操作。\n- online:发布\n- offline:下线","enum":["online","offline"],"example":"online","type":"string"},"api_id":{"description":"API的编号,即:需要进行发布或下线的API的编号","example":"57e7248244ee457cb0ddb64b012f4cbe","type":"string"},"env_id":{"description":"环境的编号,即:API需要发布到哪个环境","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","type":"string"},"remark":{"description":"对发布动作的简述。字符长度不超过255\n> 中文字符必须为UTF-8或者unicode编码。","example":"发布到生产环境","type":"string"}},"required":["env_id","api_id","action"]},"PublishResp":{"properties":{"api_id":{"description":"API编号","example":"7addcd00cfab433984b1d8bf2fe08aaa","type":"string"},"api_name":{"description":"API名称","example":"api_name","type":"string"},"env_id":{"description":"发布的环境编号","example":"DEFAULT_ENVIRONMENT_RELEASE_ID","type":"string"},"publish_id":{"description":"发布记录的ID","example":"5b729aa252764739be2c37ef0d66dc63","type":"string"},"publish_time":{"description":"发布时间","example":"2018-07-26T13:18:04.1079916Z","format":"date-time","type":"string"},"remark":{"description":"发布描述","example":"string","type":"string"},"version_id":{"description":"在线的版本号","example":"3d9dcb733ba34352b0d02f85fd16b026","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":"64330ae75eba4bb78caa1a9b81be15d7","info_version":"v2","method":"post","name":"CreateOrDeletePublishRecordForApiV2","parameters":{"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/action":{"post":{"description":"对API进行发布或下线。\n\n发布操作是将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。\n\n下线操作是将API从某个已发布的环境上下线,下线后,API将无法再被调用。","operationId":"CreateOrDeletePublishRecordForApiV2","parameters":[{"$ref":"#/parameters/apic_x_auth_token"},{"$ref":"#/parameters/apic_project_id"},{"$ref":"#/parameters/apic_instance_id"},{"description":"发布API的请求体","in":"body","name":"CreateOrDeletePublishRecordForApiV2RequestBody","required":true,"schema":{"$ref":"#/definitions/ApiActionInfo"}}],"responses":{"201":{"description":"Created","examples":{"application/json":{"api_id":"5f918d104dc84480a75166ba99efff21","env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID","publish_id":"9191cdb430724d4b8586ed7f1b962ca2","publish_time":"2020-08-03T01:36:00.592970615Z","remark":"","version_id":"ee1a5a38d3d3493abf1dc4ed6cacfa0b"}},"schema":{"$ref":"#/definitions/PublishResp"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"APIG.2011","error_msg":"Invalid parameter value,parameterName:action. 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 5f918d104dc84480a75166ba99efff21 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"}}},"schemes":["https"],"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":4,"x-request-examples-1":{"action":"online","api_id":"5f918d104dc84480a75166ba99efff21","env_id":"DEFAULT_ENVIRONMENT_RELEASE_ID"},"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"}