Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ DataArts Lake Formation/ API Reference/ API/ LakeCat/ Authorization Management/ Obtain Synchronization Permission Policies Page by Page

Obtain Synchronization Permission Policies Page by Page

Updated on 2025-02-14 GMT+08:00

Function

This API is used to obtain synchronization permission policies page by page.

URI

GET /v1/{project_id}/instances/{instance_id}/policies

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID.

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of returned records. The default value is 5000. The value ranges from 1 to 10000.

marker

No

String

ID of the record where the query starts. The value consists of 0 to 1,024 characters.

reverse_page

No

Boolean

Whether to query the previous page. The default value is false.

catalog_name

No

String

Catalog name. The value should contain 1 to 256 characters. Only letters, numbers, and underscores (_) are allowed.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

Array of strings

Tenant token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

page_info

PagedInfo object

Policy list.

policies

Array of Policy objects

Pagination information.

Table 5 PagedInfo

Parameter

Type

Description

current_count

Integer

Number of objects returned this time. The value ranges from 0 to 2000.

next_marker

String

Query address of the next page. If the next page does not exist, the value is null. (If the value is null, the response body does not contain this parameter.)

previous_marker

String

Query address of the previous page. If the previous page does not exist, the value is null. (If the value is null, the response body does not contain this parameter.)

Table 6 Policy

Parameter

Type

Description

allow_exceptions

Array of PolicyItem objects

Excluded allow rules.

conditions

Array of PolicyItemCondition objects

Condition attributes.

create_time

String

Creation time.

created_by

String

Creator.

data_mask_policy_items

Array of DataMaskPolicyItem objects

Class mask policy items.

deny_exceptions

Array of PolicyItem objects

Deny exclusion policies.

deny_policy_items

Array of PolicyItem objects

Deny policies.

description

String

Description.

guid

String

Unique GUID.

id

Long

Primary key.

is_audit_enabled

Boolean

Whether to enable auditing.

is_default_policy

Boolean

Whether this policy is the default one.

is_deny_all_else

Boolean

Whether to reject all.

is_enabled

Boolean

Whether to enable it.

name

String

Name.

options

Object

Options.

policy_items

Array of PolicyItem objects

Policy items.

policy_labels

Array of strings

Policy labels.

policy_priority

Integer

Policy priority.

policy_type

Integer

Policy type.

resource_signature

String

Resource signature.

resources

Map<String,PolicyResource>

Resources.

row_filter_policy_items

Array of RowFilterPolicyItem objects

Row-based filtering policy items.

service

String

Service.

service_type

String

Service type.

update_time

String

Update time.

updated_by

String

Updater.

validity_schedules

Array of ValiditySchedule objects

Verification period.

version

Long

Version.

zone_name

String

Zone name.

Table 7 DataMaskPolicyItem

Parameter

Type

Description

accesses

Array of PolicyItemAccess objects

Access arrays.

conditions

Array of PolicyItemCondition objects

Condition arrays.

data_mask_info

PolicyItemDataMaskInfo object

Column mask policies.

delegate_admin

Boolean

Whether to support delegation.

groups

Array of strings

User groups.

roles

Array of strings

Roles.

users

Array of strings

Users.

Table 8 PolicyItemDataMaskInfo

Parameter

Type

Description

condition_expr

String

Condition expression.

data_mask_type

String

Column mask type.

value_expr

String

Column mask expression.

Table 9 PolicyItem

Parameter

Type

Description

accesses

Array of PolicyItemAccess objects

Access control data.

conditions

Array of PolicyItemCondition objects

Conditions.

delegate_admin

Boolean

Whether to support delegation.

groups

Array of strings

Groups.

roles

Array of strings

Roles.

users

Array of strings

Users.

Table 10 PolicyResource

Parameter

Type

Description

is_excludes

Boolean

Whether to exclude it.

is_recursive

Boolean

Whether to perform this operation recursively.

values

Array of strings

Values.

Table 11 RowFilterPolicyItem

Parameter

Type

Description

accesses

Array of PolicyItemAccess objects

Permissions.

conditions

Array of PolicyItemCondition objects

Conditions.

delegate_admin

Boolean

Whether to support delegation.

groups

Array of strings

Groups.

roles

Array of strings

Roles.

row_filter_info

PolicyItemRowFilterInfo object

Row filtering.

users

Array of strings

Users.

Table 12 PolicyItemAccess

Parameter

Type

Description

is_allowed

Boolean

Whether to allow this operation.

type

String

Type.

Table 13 PolicyItemCondition

Parameter

Type

Description

type

String

Condition type.

values

Array of strings

Condition value.

Table 14 PolicyItemRowFilterInfo

Parameter

Type

Description

filter_expr

String

Row filter expression.

Table 15 ValiditySchedule

Parameter

Type

Description

end_time

String

End time.

recurrences

Array of ValidityRecurrence objects

Policy recursion.

start_time

String

Start time.

time_zone

String

Time zone.

Table 16 ValidityRecurrence

Parameter

Type

Description

interval

ValidityInterval object

Interval.

schedule

RecurrenceSchedule object

Period.

Table 17 ValidityInterval

Parameter

Type

Description

days

Integer

Days.

hours

Integer

Hours.

minutes

Integer

Minutes.

Table 18 RecurrenceSchedule

Parameter

Type

Description

day_of_month

String

Date (by month).

day_of_week

String

Date (by week).

hour

String

Hour.

minute

String

Minute.

month

String

Month.

year

String

Year.

Status code: 400

Table 19 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Status code: 404

Table 20 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Status code: 500

Table 21 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

solution_msg

String

Solution.

Example Requests

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/policies

Example Responses

Status code: 200

OK

{
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "000000001225efff0000000000000001"
  },
  "policies" : [ {
    "allow_exceptions" : [ ],
    "data_mask_policy_items" : [ ],
    "deny_exceptions" : [ ],
    "deny_policy_items" : [ ],
    "id" : 61,
    "is_audit_enabled" : true,
    "is_default_policy" : false,
    "is_deny_all_else" : false,
    "is_enabled" : true,
    "name" : "test_database_name-database",
    "options" : { },
    "policy_items" : [ {
      "accesses" : [ {
        "is_allowed" : true,
        "type" : "read"
      }, {
        "is_allowed" : true,
        "type" : "index"
      }, {
        "is_allowed" : true,
        "type" : "select"
      }, {
        "is_allowed" : true,
        "type" : "drop"
      }, {
        "is_allowed" : true,
        "type" : "alter"
      }, {
        "is_allowed" : true,
        "type" : "all"
      } ],
      "conditions" : [ {
        "type" : "ip-range",
        "values" : [ "127.0.0.1" ]
      } ],
      "delegate_admin" : true,
      "groups" : [ "testGroupName1" ],
      "roles" : [ ],
      "users" : [ ]
    }, {
      "accesses" : [ {
        "is_allowed" : true,
        "type" : "alter"
      } ],
      "conditions" : [ ],
      "delegate_admin" : false,
      "groups" : [ "testGroupName2" ],
      "roles" : [ ],
      "users" : [ ]
    } ],
    "policy_labels" : [ ],
    "policy_priority" : 0,
    "policy_type" : 0,
    "resources" : {
      "database" : {
        "is_excludes" : false,
        "is_recursive" : false,
        "values" : [ "test_database_name" ]
      }
    },
    "row_filter_policy_items" : [ ],
    "service" : "Hive",
    "service_type" : "hive",
    "validity_schedules" : [ ]
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback