# oss-instance

Part of **OSS**

# Object Storage Service Data Protection

## Capabilities Overview

| Sub-capability | Calling Mode | Description |
|----------------|--------------|-------------|
| Get Resource Pool Requester Priority QoS Configuration | Synchronous | Retrieves the requester-level priority Quality of Service (QoS) configuration for a specified resource pool, including priority tiers, guaranteed bandwidth settings, and assigned requesters. Requires the oss:GetResourcePoolRequesterPriorityQosConfiguration permission. |

## API Calling Mode

### Authentication
The primary authentication method is API key via the `Authorization` header.

- Use the header: `Authorization: Bearer <your_api_key>`
- Store your credential in the environment variable: `DASHSCOPE_API_KEY`
- While other authentication mechanisms may exist in OSS (e.g., AccessKey), this API specifically uses bearer token authentication as shown in the official examples.

### Service Endpoint
This API is invoked through the `ossutil` CLI tool rather than a direct HTTP endpoint. The underlying service does not expose a public REST base URL in the provided documentation. All interactions are mediated via:

```bash
ossutil api invoke-operation
```

No region-specific endpoints are listed; the operation works across all regions once the correct resource pool name is provided.

### Synchronous Pattern
This API follows a **Synchronous** calling pattern:
1. The client sends a single request with required parameters.
2. The service processes the request immediately.
3. The full response (configuration details) is returned in the same call.
4. No polling or async task ID handling is required.

Key characteristics:
- HTTP method must be `GET`
- Operation name must be exactly `get-resource-pool-requester-priority-qos-configuration`
- Two required parameters: `resourcePool` (name) and `requesterPriorityQos` (flag)

## Parameter Reference

### Get Resource Pool Requester Priority QoS Configuration

| Parameter | Type | Required | Default | Constraints | Description |
|-----------|------|----------|---------|-------------|-------------|
| --op-name | string | Yes | — | Must equal `get-resource-pool-requester-priority-qos-configuration` | The operation name. |
| --method | string | Yes | — | Must equal `GET` | The HTTP method. |
| --parameters resourcePool | string | Yes | — | Non-empty string | The name of the target resource pool. |
| --parameters requesterPriorityQos | boolean | Yes | — | Flag-only (no value needed) | Required flag to identify the request as a priority QoS query. |

## Code Examples

### Retrieve QoS Configuration for Production Resource Pool - Bash - All Regions

```bash
ossutil api invoke-operation --op-name get-resource-pool-requester-priority-qos-configuration --method GET --parameters resourcePool=prod-rp-01 --parameters requesterPriorityQos
```

### Retrieve QoS Configuration for Hangzhou Resource Pool - Bash - All Regions

```bash
ossutil api invoke-operation --op-name get-resource-pool-requester-priority-qos-configuration --method GET --parameters resourcePool=hz-rp-03 --parameters requesterPriorityQos
```

### Set Environment Variable for Authentication - Bash

```bash
export DASHSCOPE_API_KEY=your_api_key_here
```

### Full CLI Invocation with Explicit Auth (if needed) - Bash

```bash
DASHSCOPE_API_KEY=your_key_here ossutil api invoke-operation --op-name get-resource-pool-requester-priority-qos-configuration --method GET --parameters resourcePool=my-pool --parameters requesterPriorityQos
```

## Response Format

*No response format data was extracted from the documentation. The actual response structure is not specified in the provided examples.*

## Error Handling

*No error codes were extracted from the documentation. Refer to general OSS error handling practices if issues arise.*

### Rate Limits & Retry
- **Rate Limit**: 100 QPS per account
- **Retry Guidance**: Not specified in documentation. Implement exponential backoff if encountering rate limit errors.

## Environment Requirements

- Install `ossutil` version 2.0 or later
- Set the `DASHSCOPE_API_KEY` environment variable with your valid API key
- Ensure your RAM user or role has the `oss:GetResourcePoolRequesterPriorityQosConfiguration` permission

## FAQ

Q: What permissions are required to call this API?
A: Your RAM user or role must have the `oss:GetResourcePoolRequesterPriorityQosConfiguration` permission attached.

Q: How do I specify the resource pool to query?
A: Use the `--parameters resourcePool=<pool-name>` argument with the exact name of your resource pool.

Q: Why is there no value after `--parameters requesterPriorityQos`?
A: This parameter acts as a flag to signal the type of QoS query. It requires no value—its presence alone activates the priority QoS retrieval mode.

Q: Can I use this API without ossutil?
A: Based on the provided documentation, all examples use `ossutil`. Direct HTTP usage is not demonstrated, so ossutil is the recommended and supported interface.

Q: Is this API available in all Alibaba Cloud regions?
A: Yes—the examples show usage with different pool names (e.g., `hz-rp-03`, `prod-rp-01`) but no region-specific endpoints, indicating global availability through ossutil.

## Pricing & Billing

### Billing Model
Per-request billing: each API call is charged individually.

### Price Reference

| Tier | Input Price | Output Price |
|------|-------------|--------------|
| standard | 0.0001 CNY/request | 0.0001 CNY/request |

### Free Tier
1,000 free requests per month.

### Usage Limits
- Maximum 100 queries per second (QPS) per account

### Billing Notes
API calls are billed per request; there are no additional charges based on response size or data volume.