Updated on 2024-08-15 GMT+08:00

API Access Permission (Customer)

A customer needs to obtain permissions before accessing APIs. Customers' API access permissions can be granted in IAM. Supported actions of APIs are listed in the following table. The API cannot be accessed if one of its actions is not supported.

For more information, visit Customer Operations Capability API.

  • For APIs not listed in the table, fine-grained permission verification is not required and all customer accounts can access them.
  • Authentication of system-defined roles is not supported, but policy authentication is. For details about the configuration guide, see Creating a User Group and Assigning Permissions.
Table 1

Scenario

Sub-Scenario

API

URL

Permission Code

Supported Action

Managing products

Querying product price

Querying pay-per-use product price

POST /v2/bills/ratings/on-demand-resources

bss:discount:view

View discount and price information.

Querying the price of a yearly/monthly product

POST /v2/bills/ratings/period-resources/subscribe-rate

bss:discount:view

View discount and price information.

Managing accounts

Managing accounts

Querying account balance

GET/v2/accounts/customer-accounts/balances

bss:balance:view

View account information.

Managing transactions

Managing yearly/monthly orders

Querying orders

GET /v2/orders/customer-orders

bss:order:view

View order information.

Querying order details

GET /v2/orders/customer-orders/details/{order_id}

bss:order:view

View order information.

Querying available discounts of an order

GET /v2/orders/customer-orders/order-discounts

bss:discount:view

View discount and price information.

Canceling orders in the pending payment status

PUT /v2/orders/customer-orders/cancel

bss:order:update

Place orders, cancel orders, and modify recipient information.

Paying a yearly/monthly order

POST /v3/orders/customer-orders/pay

bss:order:pay

Pay orders.

Querying financial information of an order unsubscribed from

GET /v2/orders/customer-orders/refund-orders

bss:order:view

View order information.

Managing yearly/monthly resources

Querying yearly/monthly resource list

POST /v2/orders/suscriptions/resources/query

bss:order:view

View order information.

Renewing subscriptions to yearly/monthly resources

POST /v2/orders/subscriptions/resources/renew

bss:renewal:update

Place orders, cancel orders, and modify recipient information.

Unsubscribing from yearly/monthly resources

POST /v2/orders/subscriptions/resources/unsubscribe

bss:order:update

Place orders, cancel orders, and modify recipient information.

Enabling automatic renewal for yearly/monthly resources

POST /v2/orders/subscriptions/resources/autorenew/**

bss:renewal:update

Place orders, cancel orders, and modify recipient information.

Disabling automatic renewal for yearly/monthly resources

DELETE /v2/orders/subscriptions/resources/autorenew/{resource_id}

bss:renewal:update

Place orders, cancel orders, and modify recipient information.

Enabling/Canceling the change from yearly/monthly to pay-per-use upon expiration

POST /v2/orders/subscriptions/resources/to-on-demand

bss:renewal:update

Place orders, cancel orders, and modify recipient information.

Managing bills

Managing bills

Viewing bill details

POST /v2/bills/customer-bills/res-records/query

bss:billDetail:view

View expenditure details, resource expenditures, bill analysis, and historical payments.

Querying bill summary

GET /v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum

bss:bill:view

View bills, monthly costs, usage details, cost management, expenditures and revenues, and cost trends.

Querying expenditure records

GET /v2/bills/customer-bills/res-fee-records

bss:bill:view

View bills, monthly costs, usage details, cost management, expenditures and revenues, and cost trends.

Managing costs

Managing costs

Querying cost data

POST /v4/costs/cost-analysed-bills/query

bss:costanalysis:view

View cost analysis.