调用DescribeServicePolicy查询权限规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeServicePolicy

系统规定参数。取值:DescribeServicePolicy。

ServiceName String db

服务名称。可选值:

  • db
  • file
SpaceId String 0e16bb12-14af-****-b24c-5ac1a9a7bb9f

服务空间ID。

CollectionName String test

集合名称。该参数非必填,且仅在serviceNamedb时有意义。

返回数据

名称 类型 示例值 描述
CollectionName String test

集合名称。

Policy String {\".write\":false,\".read\":true}

权限规则。

PolicyName String ADMINWRITEONLY

权限模式,可能取值为。

  • PUBLICREAD: 所有用户可读,仅创建者及管理员可写。
  • PRIVATE: 仅创建者及管理员可读写。
  • ADMINWRITEONLY: 所有用户可读,仅管理员可写。
  • ADMINREADWRITEONLY: 仅管理员可读写。
  • EXTENDED: 自定义安全规则。
RequestId String 15F08A3A-DDBC-4199-93CA-343419E81235

请求ID。

ServiceName String db

服务名称。

SpaceId String 0e16bb12-14af-****-b24c-5ac1a9a7bb9f

服务空间ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeServicePolicy
&ServiceName=db
&SpaceId=0e16bb12-14af-****-b24c-5ac1a9a7bb9f
&CollectionName=test
&<公共请求参数>

正常返回示例

XML 格式

<DescribeServicePolicyResponse>
      <Policy>{".write":false,".read":true}</Policy>
      <RequestId>42B1D550-53CA-4DFC-A081-94D8DF00B81B</RequestId>
      <ServiceName>db</ServiceName>
      <CollectionName>test</CollectionName>
      <PolicyName>ADMINWRITEONLY</PolicyName>
      <HttpStatusCode>200</HttpStatusCode>
      <SpaceId>826061c4-5095-4550-8b74-3bcd9af*****</SpaceId>
      <Success>true</Success>
</DescribeServicePolicyResponse>

JSON 格式

{
    "Policy": "{\".write\":false,\".read\":true}",
    "RequestId": "42B1D550-53CA-4DFC-A081-94D8DF00B81B",
    "ServiceName": "db",
    "CollectionName": "test",
    "PolicyName": "ADMINWRITEONLY",
    "HttpStatusCode": "200",
    "SpaceId": "826061c4-5095-4550-8b74-3bcd9af*****",
    "Success": true
}