接口功能介绍
本接口用于修改单个目录信息。
接口约束
请求参数说明:
String类型的参数,传""等同于不传。
Integer类型的参数,传0等同于不传。
Boolean类型的参数,传false等同于不传。
URI
PUT /v2/dirs/*
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
DirId | 是 | String | 目录ID。 | 897098424844288 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
DirName | 是 | String | 目录名称,长度不超过64个字符。 | openapi-dir | |
Description | 否 | String | 目录描述,长度不超过255个字符。 | description |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 响应状态码。 | 200 | |
error | String | 错误码,执行成功时,不返回该字段。 | VSS_0001 | |
message | String | 响应信息。 | 请求成功 | |
requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
returnObj | Object | 响应数据,执行失败时,不返回该字段。 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
DirId | String | 目录ID。 | 693323900457467904 | |
RequestId | String | 请求ID。 | 432a3ea5157740d296194ebf188f9403 |
枚举参数
无
请求示例
请求url
PUT '/v2/dirs/693323900457467904'
请求头header
无
请求体body
{"DirName":"openapi-dir"}
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "432a3ea5157740d296194ebf188f9403","returnObj": {"DirId": "693323900457467904","RequestId": "432a3ea5157740d296194ebf188f9403"}}
状态码
请参考 状态码
错误码
请参考 错误码