修改服务
功能介绍
修改服务。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/link/instances/{instance_id}/services/{service_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度:0 最大长度:32 |
instance_id |
是 |
String |
实例ID。 最小长度:0 最大长度:36 |
service_id |
是 |
String |
服务ID。 最小长度:0 最大长度:20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
service_name |
是 |
String |
服务名称,支持中文、英文大小写、数字、下划线和中划线,长度2-64。 最小长度:2 最大长度:64 |
description |
否 |
String |
服务描述,长度0-200。 最小长度:0 最大长度:200 |
status |
是 |
Integer |
服务状态,0-启用,1-停用。 最小值:0 最大值:10 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
product_template_id |
Integer |
服务归属的产品模板ID。 最小值:1 最大值:99999999999999999 |
product_id |
Integer |
服务归属的产品ID。 最小值:1 最大值:99999999999999999 |
service_id |
Integer |
服务ID。 最小值:1 最大值:99999999999999999 |
service_name |
String |
服务名称,支持中文、英文大小写、数字、下划线和中划线,长度2-64。 最小长度:2 最大长度:64 |
description |
String |
服务描述,长度0-200。 最小长度:0 最大长度:200 |
status |
Integer |
服务状态,0-启用,1-停用。 最小值:0 最大值:10 |
created_user |
CreatedUser object |
创建时的用户。 |
last_updated_user |
LastUpdatedUser object |
最后更新时的用户。 |
created_datetime |
Long |
创建时间止,格式timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
last_updated_datetime |
Long |
最后修改时间止,格式timestamp(ms),使用UTC时区。 最小值:1 最大值:99999999999999999 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户ID(保留字段,未使用)。 最小长度:0 最大长度:64 |
user_name |
String |
用户名。 最小长度:0 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户ID(保留字段,未使用)。 最小长度:0 最大长度:64 |
user_name |
String |
用户名。 最小长度:0 最大长度:64 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述。 最小长度:0 最大长度:200 |
request_id |
String |
消息ID。 最小长度:0 最大长度:64 |
请求示例
修改指定服务的名称、描述和状态信息。
{ "service_name" : "service", "description" : "service", "status" : 0 }
响应示例
状态码: 200
OK
{ "product_id" : 122893, "service_id" : 10190, "service_name" : "s1", "description" : null, "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607502702474, "last_updated_datetime" : 1607572282845 }
状态码: 400
Bad Request
{ "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.updateService]. Parameter is [service_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" }
状态码: 404
Not Found
{ "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" }
状态码: 500
Internal Server Error
{ "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。