发布或下线API - CreateOrDeletePublishRecordForApiV2
功能介绍
对API进行发布或下线。
发布操作是将一个指定的API发布到一个指定的环境，API只有发布后，才能够被调用，且只能在该环境上才能被调用。未发布的API无法被调用。
下线操作是将API从某个已发布的环境上下线，下线后，API将无法再被调用。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/apic/instances/{instance_id}/apis/action
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
instance_id |
是 |
String |
实例ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
需要进行的操作。
|
|
api_id |
是 |
String |
API的编号，即：需要进行发布或下线的API的编号 |
|
env_id |
是 |
String |
环境的编号，即：API需要发布到哪个环境 |
|
remark |
否 |
String |
对发布动作的简述。字符长度不超过255
说明：
中文字符必须为UTF-8或者unicode编码。
|
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
publish_id |
String |
发布记录的ID |
|
api_id |
String |
API编号 |
|
api_name |
String |
API名称 |
|
env_id |
String |
发布的环境编号 |
|
remark |
String |
发布描述 |
|
publish_time |
String |
发布时间 |
|
version_id |
String |
在线的版本号 |
状态码：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 |
错误描述 |
请求示例
发布一个API到指定环境上
{
"action" : "online",
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID"
}
响应示例
状态码：201
Created
{
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"publish_id" : "9191cdb430724d4b8586ed7f1b962ca2",
"publish_time" : "2020-08-03T01:36:00.592970615Z",
"version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b",
"remark" : ""
}
状态码：400
Bad Request
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:action. 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.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist"
}
状态码：500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
