华为云用户手册

  • 配额管理 表3 配额管理权限项列表 权限 对应API接口 授权项 IAM 项目 (Project) 企业项目 (Enterprise Project) 获取文件系统配额 GET /{file-system-name}?quota sfs3:fileSystem:getQuota × √ 设置文件系统配额 PUT /{file-system-name}?quota sfs3:fileSystem:putQuota × √
  • 获取访问密钥(AK/SK) IAM用户若希望使用AK/SK访问SFS,必须要账号为其开启“编程访问”。开启方法请参见查看或修改IAM用户信息。 在调用接口的时候,需要使用AK/SK进行签名验证。AK/SK获取步骤如下: 登录控制台。 鼠标指向界面右上角的登录用户名,在下拉列表中单击“我的凭证”。 单击“管理访问密钥”。 在左侧导航栏单击“访问密钥”。 单击“新增访问密钥”,进入“新增访问密钥”页面。 输入当前用户的登录密码。 通过邮箱或者手机进行验证,输入对应的验证码。 在 统一身份认证 服务IAM中创建的用户,如果创建时未填写邮箱或者手机号,则只需校验登录密码。 单击“确定”,浏览器自动下载访问密钥。 为防止访问密钥泄露,建议您将其保存到安全的位置。 父主题: 附录
  • 响应示例 HTTP/1.1 204 No Content Server: OBS X-Obs-Id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAA BCS j4dxiqb1Lw50CTjVQeV3ebh3QQ6PAj X-Obs-Request-Id: 0000018893B807D5C0472A6161D87032 Date: WED, 01 Jul 2015 02:36:06 GMT
  • 响应示例 HTTP/1.1 200 OK Server: OBS Content-Type: application/json Content-Length: 131 Date: Wed, 07 Jun 2023 03:31:59 GMT X-Obs-Request-Id: 0000018893E94B65C046B527778F8F14 X-Obs-Id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAAB CS c2lEdSHcA04319WknB1DD5BdBKuGr1 { "Statement": [ { "Condition": { "SourceVpc": "f85adabc-a387-4d1d-94cf-65ef9034f752" }, "Action": "FullControl", "Effect": "Allow", "Sid": "" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 Statement Array of Statement objects Unique identification 表4 Statement 参数 参数类型 描述 Sid String statement Id,描述statement的字符串 Action String 本条statement作用的操作,取值范围:FullControl(读写)、Read(只读)。 枚举值: FullControl Read Effect String 效果,指定本条statement的权限是允许,必须为Allow。 枚举值: Allow Condition Condition object 本条statement生效的条件。 表5 Condition 参数 参数类型 描述 SourceVpc String 指定VPC的VPCid。 VpcSourceIp Array of strings 指定的IP或IP范围(暂不支持该参数)。
  • 请求示例 设置文件系统ACL,授予读写权限,VPC ID为“241dbf6b-dc5d-41b2-9108-ca5e56b48386”,IP范围为["127.0.0.1/24", "192.168.1.85/24"]。 PUT /?sfsacl HTTP/1.1 Host: examplefilesystem.sfs3.cn-north-4.myhuaweicloud.com Date: WED, 01 Jul 2015 02:32:25 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:jZiAT8Vx4azWEvPRMWi0X5BpJMA= { "Statement": [{ "Sid": "Stmt1375240018061", "Action": "FullControl", "Effect": "Allow", "Condition": { "SourceVpc": "241dbf6b-dc5d-41b2-9108-ca5e56b48386", "VpcSourceIp": ["127.0.0.1/24", "192.168.1.85/24"] } }] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Date 是 String 请求消息时间 Authorization 是 String 请求签名信息 Host 是 String 表明主机地址。如filesystem.sfs3.cn-north-4.myhuaweicloud.com。 表3 请求Body参数 参数 是否必选 参数类型 描述 Statement 否 Array of Statement objects Unique identification 表4 Statement 参数 是否必选 参数类型 描述 Sid 否 String statement Id,描述statement的字符串 Action 是 String 本条statement作用的操作,取值范围:FullControl(读写)、Read(只读)。 枚举值: FullControl Read Effect 是 String 效果,指定本条statement的权限是允许,必须为Allow。 枚举值: Allow Condition 是 Condition object 本条statement生效的条件。 表5 Condition 参数 是否必选 参数类型 描述 SourceVpc 是 String 指定VPC的VPCid。 VpcSourceIp 否 Array of strings 指定的IP或IP范围(暂不支持该参数)。
  • 请求示例 DELETE / HTTP/1.1 User-Agent: curl/7.29.0 Host: examplefilesystem.sfs3.cn-north-4.myhuaweicloud.com Accept: */* Date: WED, 01 Jul 2015 02:31:25 GMT Authorization: OBS H4IPJX0TQTHTHEBQQCEC:jZiAT8Vx4azWEvPRMWi0X5BpJMA=
  • 响应示例 HTTP/1.1 204 No Content Server: OBS X-Obs-Request-Id: 0000018893B8081DC047305E783867DD X-Obs-Id-2: 32AAAQAAEAABSkAgAAEAABAAAQAAEAABCT5UWgsaro3EEnOsNEzf8w8dnydR+Eak Date: WED, 01 Jul 2015 02:31:25 GMT
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 签名信息 Date 是 String 请求时间 x-obs-bucket-type 是 String 通过此消息头明确创建文件系统。 取值: SFS:创建文件系统。 枚举值: SFS Host 是 String 表明主机地址。如filesystem.sfs3.cn-north-4.myhuaweicloud.com。 x-obs-epid 否 String 企业项目ID 表2 请求Body参数 参数 是否必选 参数类型 描述 Location 否 String 区域
  • 响应示例 HTTP/1.1 200 OK Server: OBS X-Obs-Request-Id: 0000018893B8058EC0470388BE6EDE88 Location: /example-sfs-01 X-Obs-Id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCTRa4voOUvr50ncznQT/hligMxL4so2z Date: Wed, 07 Jun 2023 02:38:11 GMT Content-Length: 0
  • 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 详细的公共响应消息头字段请参见表1。 表1 公共响应消息头 消息头名称 描述 Content-Length 响应消息体的字节长度。 类型:字符串。 默认值:无。 Connection 指明与服务器的连接是长连接还是短连接。 类型:字符串。 有效值:keep-alive | close。 默认值:无。 Date 系统响应的时间。 类型:字符串。 默认值:无。 x-obs-id-2 帮助定位问题的特殊符号。 类型:字符串。 默认值:无。 x-obs-request-id 由SFS创建来唯一确定本次请求的值,可以通过该值来定位问题。 类型:字符串。 默认值:无。
  • 签名计算工具 SFS提供可视化签名计算工具,帮助您轻松完成签名计算。 表1 签名计算工具 签名计算方式 签名计算工具获取地址 Header中携带签名 可视化签名计算工具 若调用SFS API报如下错误: 状态码:403 Forbidden 错误码:SignatureDoesNotMatch 错误信息:The request signature we calculated does not match the signature you provided. Check your key and signing method. 请联系技术支持。 父主题: 认证鉴权
  • 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 状态码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 正常 返回值 说明 200 OK GET和PUT操作正常返回。 201 Created POST操作正常返回。 202 Accepted 请求已被接受。 204 No Content DELETE操作正常返回。 异常 返回值 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突,请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。 父主题: 附录
  • Console引用 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 更改安全组 Console引用 sfsturbo:shares:shareAction 更改安全组需要安全组相关权限: vpc:securityGroups:* vpc:securityGroupRules:* √ √ 查询sfs turbo配额 Console引用 sfsturbo:shares:getQuota - √ √ 获取可用区信息 Console引用 sfsturbo:shares:getAZInfo - √ √ 获取sfs turbo规格信息 Console引用 sfsturbo:shares:getFlavors - √ √ 检查文件系统名称 Console引用 sfsturbo:shares:checkShareName - √ √
  • 文件系统 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建文件系统 POST /v1/{project_id}/sfs-turbo/shares sfsturbo:shares:createShare 创建SFS Turbo实例时,需要vpc相关权限,包括校验vpc、子网、安全组,创建vip以及port,创建安全组规则等,需要增加授权项: "vpc:*:*" 加密实例需要在项目上配置KMS Administrator权限 专属场景,需要增加授权项: "dss:*:get", "dss:*:list", "dss:*:count" √ √ 查询所有文件系统详细信息 GET /v1/{project_id}/sfs-turbo/shares/detail sfsturbo:shares:getAllShares - √ √ 查询单个文件系统详细信息 GET /v1/{project_id}/sfs-turbo/shares/{share_id} sfsturbo:shares:getShare - √ √ 删除文件系统 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id} sfsturbo:shares:deleteShare 删除SFS Turbo实例时,需要vpc相关权限,包括删除vip以及port,删除安全组规则等,需要增加授权项: "vpc:*:*" 如果是专属场景,需要增加授权项: "dss:*:get", "dss:*:list", "dss:*:count" √ √ 创建文件系统异步任务 POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks sfsturbo:shares:createFsAsyncTask - √ √ 获取文件系统异步任务列表 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks sfsturbo:shares:listFsAsyncTasks - √ √ 获取文件系统异步任务详情 GET /v1/{project_id}/sfs- turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} sfsturbo:shares:showFsAsyncTask - √ √ 取消/删除文件系统异步任务 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id} sfsturbo:shares:deleteFsAsyncTask - √ √ 绑定后端存储 POST /v1/{project_id}/sfs-turbo/shares/{share_id}/targets sfsturbo:shares:createBackendTarget 用户需要额外配置OBS Adminstrator权限。 √ √ 查询后端存储列表 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets sfsturbo:shares:listBackendTargets - √ √ 获取后端存储详细信息 GET /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id} sfsturbo:shares:showBackendTargetInfo - √ √ 删除后端存储 DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/targets/{target_id} sfsturbo:shares:deleteBackendTarget - √ √ 创建数据导入导出任务 POST /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task sfsturbo:shares:createDataRepositoryTask - √ √ 查询数据导入导出任务详情 GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/task/{task_id} sfsturbo:shares:getDataRepositoryTask - √ √ 查询数据导入导出任务列表 GET /v1/{project_id}/sfs-turbo/{share_id}/hpc-cache/tasks sfsturbo:shares:getAllDataRepositoryTasks - √ √
  • 扩容缩容 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 扩容共享 (OpenStack原生) POST /v2/{project_id}/shares/{share_id}/action sfs:shares:ShareAction √ √ 缩容共享 (OpenStack原生) POST /v2/{project_id}/shares/{share_id}/action sfs:shares:ShareAction √ √
  • 共享标签 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 添加共享标签 POST /v2/{project_id}/sfs/{share_id}/tags sfs:tags:addShareTags √ × 删除共享标签 DELETE /v2/{project_id}/sfs/{share_id}/tags/{key} sfs:tags:deleteShareTags √ × 查询共享标签 GET /v2/{project_id}/sfs/{share_id}/tags sfs:tags:getShareTags √ × 查询租户所有共享标签 GET /v2/{project_id}/sfs/tags sfs:tags:getAllTags √ × 批量添加共享标签 POST /v2/{project_id}/sfs/{share_id}/tags/action sfs:tags:batchShareTags √ × 批量删除共享标签 POST /v2/{project_id}/sfs/{share_id}/tags/action sfs:tags:batchShareTags √ × 根据标签查询共享详情 POST /v2/{project_id}/sfs/resource_instances/action sfs:tags:getShareByTags √ × 根据标签查询共享个数 POST /v2/{project_id}/sfs/resource_instances/action sfs:tags:getShareByTags √ ×
  • 共享访问规则 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 添加共享访问规则 (OpenStack原生) POST /v2/{project_id}/shares/{share_id}/action sfs:shares:ShareAction √ √ 删除共享访问规则 (OpenStack原生) POST /v2/{project_id}/shares/{share_id}/action sfs:shares:ShareAction √ √ 查询共享访问规则 (OpenStack原生) POST /v2/{project_id}/shares/{share_id}/action sfs:shares:ShareAction √ √
  • 文件共享 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 创建共享 (OpenStack原生) POST /v2/{project_id}/shares sfs:shares:createShare √ √ 查询所有共享 (OpenStack原生) GET /v2/{project_id}/shares sfs:shares:getShare √ √ 查询所有共享详细信息 (OpenStack原生) GET /v2/{project_id}/shares/detail sfs:shares:getAllSharesDetail √ √ 查询单个共享详细信息 (OpenStack原生) GET /v2/{project_id}/shares/{share_id} sfs:shares:getShareDetail √ √ 查询共享挂载路径 (OpenStack原生) GET /v2/{project_id}/shares/{share_id}/export_locations sfs:shares:getShareExportLocations √ √ 修改共享 (OpenStack原生) PUT /v2/{project_id}/shares/{share_id} sfs:shares:updateShare √ √ 删除共享 (OpenStack原生) DELETE /v2/{project_id}/shares/{share_id} sfs:shares:deleteShare √ √
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。 弹性文件服务支持的自定义策略授权项如下所示: 【示例】文件共享,包含SFS所有文件系统接口对应的授权项,如创建文件系统、查询文件系统列表、查询单个文件系统详情、修改文件系统、删除文件系统等接口。 【示例】扩容缩容,包括SFS文件系统扩容缩容接口对应的授权项,如扩容共享和缩容共享等接口。 【示例】SFS Turbo授权项分类,包含SFS Turbo所有文件系统接口对应的授权项,如创建文件系统、查询文件系统列表、查询单个文件系统详情、删除文件系统等接口。
  • 状态码 正常 200 异常 状态码 说明 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突,请求无法被完成。 500 Internal Server Error 请求未完成。服务异常。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。
  • URI GET /v2/{project_id}/availability-zones?share_az={share_az} 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 操作用户的项目ID,获取方法请参见获取项目ID。 share_az 否(查询参数) Boolean 取值为true时,表示当前租户可以查询所有能够创建共享的AZ,取值为false时,表示可以查询所有AZ,包含能创建共享和不能创建共享的AZ。
  • 响应消息 参数说明 参数 参数类型 描述 availability_zones Array of objects availability_zone列表 availability_zone 字段说明: 参数 参数类型 描述 id String 可用区的ID。 name String 可用区的名称。 created_at String 创建可用区的时间标签。 updated_at String 修改可用区的时间标签。 响应样例 { "availability_zones": [ { "updated_at": null, "created_at": "2018-07-10T19:11:49.831107", "id": "ddafcb71-face-4526-a637-9768d19b20f3", "name": "az1.dc1" } ] }
  • 请求消息 参数说明 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值范围为:“filter”和“count”。 根据标签查询共享实例个数时使用“count”。 matches 否 Array of matches 共享资源搜索字段。当该字段不设置时,默认为搜索租户的所有共享。 tags 否 Array of tags 标签搜索字段。包含标签,结果返回满足tags搜索条件的共享资源列表。搜索条件中所有tag之间是“与”的关系,即只有当所有tag搜索条件都满足时,共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无tags过滤条件时,默认认为这个标签搜索字段满足要求。最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 tags_any 否 Array of tags 标签搜索字段。包含任意标签,结果返回满足tags_any搜索条件的共享资源列表。搜索条件中所有tag之间是“或”的关系,即只要有其中一个tag搜索条件满足要求时,共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无tags_any过滤条件时,默认认为这个标签搜索字段满足要求。查询条件最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 not_tags 否 Array of tags 标签搜索字段。不包含标签,结果返回满足not_tags搜索条件的共享资源列表,搜索条件中所有tag之间是“或非”的关系,即只有当所有tag搜索条件都不满足要求时,共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无not_tags过滤条件时,默认认为这个标签搜索字段满足要求。最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 not_tags_any 否 Array of tags 标签搜索字段。不包含任意标签,结果返回满足not_tags_any搜索条件的共享资源列表,查询条件中所有tag之间是“与非”的关系,即只要有一个tag搜索条件不满足要求时,共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无not_tags_any过滤条件时,默认认为这个标签搜索字段满足要求。查询条件最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 sys_tags 否 Array of tags 仅op_service权限可以使用此字段做资源实例过滤条件: 目前TMS调用时只包含一个tag结构体 key:_sys_enterprise_project_id。 目前TMS调用时key下面只包含一个value,0表示默认企业项目。 sys_tags和租户标签过滤条件(tags、tags_any、not_tags、not_tags_any)不能同时使用。 请求参数中,标签搜索字段tags/not_tags/tags_any/not_tags_any为非必选且可以任意自由组合,标签搜索字段tags/not_tags/tags_any/not_tags_any之间为“与”的关系。 match字段说明: 参数 是否必选 参数类型 描述 key 是 String 键。固定值为"resource_name"。 value 是 String 值。需要查询的共享的名称。value为空字符串时,精确匹配名称为空的共享,为非空字符串时模糊匹配(不区分大小写)。每个值最大长度为255个字符 。 tag字段说明: 参数 是否必选 参数类型 描述 key 是 String 标签的键。最大长度127个字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个字符,如果values为空列表,则表示匹配任意值value。value之间为或的关系。 请求样例 根据标签查询共享实例个数,查询的共享名称为“share_name”,标签的键为“key1”,值为["value2"]。 { "action": "count", "matches": [{ "key": "resource_name", "value": "share_name" }], "tags": [{ "key": "key1", "values": ["value2"] }, { "key": "key2", "values": [] }], "tags_any": [{ "key": "key3", "values": ["value3"] }, { "key": "key4", "values": [] }], "not_tags": [{ "key": "key5", "values": ["value5"] }, { "key": "key6", "values": [] }], "not_tags_any": [{ "key": "key7", "values": ["value7", "value8"] }, { "key": "key9", "values": [] }] }
  • 请求消息 参数说明 参数 是否必选 参数类型 描述 offset 否 String 索引位置。整型数字字符串,默认为0,必须为数字,不能为负数。返回的结果中第一条记录为符合查询条件的第offset+1条记录。 limit 否 String 查询记录数。整型数字字符串,默认为1000。最小值为1,最大值为1000。 返回的结果中记录数不超过limit。 action 是 String 操作标识。取值范围为:“filter”和“count”。 根据标签查询共享详情时使用“filter”。 matches 否 Array of matchs 共享资源搜索字段。当该字段不设置时,默认为搜索租户的所有共享。 tags 否 Array of tags 标签搜索字段。包含标签,结果返回满足tags搜索条件的共享资源列表。搜索条件中所有tag之间是“与”的关系,即只有当所有tag搜索条件都满足时,共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无tags过滤条件时,默认认为这个标签搜索字段满足要求。最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 tags_any 否 Array of tags 标签搜索字段。包含任意标签,结果返回满足tags_any搜索条件的共享资源列表。搜索条件中所有tag之间是“或”的关系,即只要有其中一个tag搜索条件满足要求时,共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无tags_any过滤条件时,默认认为这个标签搜索字段满足要求。查询条件最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 not_tags 否 Array of tags 标签搜索字段。不包含标签,结果返回满足not_tags搜索条件的共享资源列表,搜索条件中所有tag之间是“或非”的关系,即只有当所有tag搜索条件都不满足要求时,共享资源才可以被搜索。每个tag搜索条件的key-values结构中values数组的值之间是“或”的关系。无not_tags过滤条件时,默认认为这个标签搜索字段满足要求。最多包含10个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 not_tags_any 否 Array of tags 标签搜索字段。不包含任意标签,结果返回满足not_tags_any搜索条件的共享资源列表,查询条件中所有tag之间是“与非”的关系,即只要有一个tag搜索条件不满足要求时,共享资源便可以被搜索。每个tag搜索条件的key-values结构中values数组之间是“或”的关系。无not_tags_any过滤条件时,默认认为这个标签搜索字段满足要求。查询条件最多包含10个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key-values结构中values的值之间不能重复。 sys_tags 否 Array of tags 仅op_service权限可以使用此字段做资源实例过滤条件: 目前TMS调用时只包含一个tag结构体 key:_sys_enterprise_project_id。 目前TMS调用时key下面只包含一个value,0表示默认企业项目。 sys_tags和租户标签过滤条件(tags、tags_any、not_tags、not_tags_any)不能同时使用。 请求参数中,标签搜索字段tags/not_tags/tags_any/not_tags_any为非必选且可以任意自由组合,标签搜索字段tags/not_tags/tags_any/not_tags_any之间为“与”的关系。 match字段说明: 参数 是否必选 参数类型 描述 key 是 String 键。固定值为"resource_name"。 value 是 String 值。需要查询的共享的名称。value为空字符串时,精确匹配名称为空的共享,为非空字符串时模糊匹配(不区分大小写)。每个值最大长度为255个字符 。 tag字段说明: 参数 是否必选 参数类型 描述 key 是 String 标签的键。最大长度127个字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个字符,如果values为空列表,则表示匹配任意值value。value之间为或的关系。 请求样例 根据标签查询共享详情,要查询的共享的标签的键是“key1”,值为“value2”。 { "offset": "0", "limit": "100", "action": "filter", "matches": [{ "key": "resource_name", "value": "share_name" }], "tags": [{ "key": "key1", "values": ["value2"] }, { "key": "key2", "values": [] }], "tags_any": [{ "key": "key3", "values": ["value3"] }, { "key": "key4", "values": [] }], "not_tags": [{ "key": "key5", "values": ["value5"] }, { "key": "key6", "values": [] }], "not_tags_any": [{ "key": "key7", "values": ["value7", "value8"] }, { "key": "key9", "values": [] }] }
  • 请求消息 参数说明 参数 是否必选 参数类型 描述 action 是 String 操作标识,取值范围为:“create”和“delete”。 为指定共享批量删除标签时使用“delete”。 tags 是 Array of resource_tags 标签列表。 resource_tag字段说明: 参数 是否必选 参数类型 描述 key 是 String 标签的键。 最大长度36个字符。 key不能为空。 value 否 String 标签的值。 每个值最大长度43个字符,可以为空字符串。 如果value有值,则按照key+value精确匹配删除对应的标签;如果value没值,则按照key删除。 请求样例 批量删除标签,删除的第一个标签的键为“key1”,值为“value1”;第二个标签的键为“key2”;第三个标签的键为“key3”。 { "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2" }, { "key": "key3", "value": "" } ] }
  • 响应消息 参数说明 参数 参数类型 描述 tags Array of tags tag标签的列表。 tag字段说明: 参数 参数类型 描述 key String 标签的键。 values Array of strings 标签的值列表。租户所有共享标签值的列表,重复的标签值只显示一次。 响应样例 { "tags" : [ { "key" : "key1", "values" : [ "value1", "" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ] }
  • 响应消息 参数说明 参数 参数类型 描述 tags Array of resource_tags tag标签的列表。 sys_tags Array of resource_tags 仅op_service权限才可以获取此字段: 目前只包含一个resource_tag结构体 key:_sys_enterprise_project_id 目前key下面只包含一个value,0表示默认企业项目。 非op_service场景不能返回此字段。 resource_tag字段说明: 参数 参数类型 描述 key String 标签的键。 value String 标签的值。 响应样例 { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "" } ] }
共100000条