修改实例备注
URI
PUT /v3/{project_id}/instances/{instance_id}/alias
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in07,长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
alias |
是 |
String |
参数解释: 实例备注。 约束限制: 不涉及。 取值范围: 长度可在0~64个字符之间,由字母、数字、汉字、英文句号、下划线、中划线或空格组成,且空格不能出现在开头和结尾的位置。 默认取值: 不涉及。 |
响应参数
状态码:200
Success.
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息。 |
请求示例
将实例备注修改为“Test_alias”。
PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/alias { "alias" : "Test_alias" }
响应示例
状态码: 200
Success.
{ }
状态码
请参见状态码。
错误码
请参见错误码。