Updating an API Key

project_id

Yes

String

Definition: Project ID, which uniquely identifies tenant resources in Huawei Cloud and is associated with a specific region. It is used to locate the project space to which the resources belong when calling Huawei Cloud APIs. You can obtain the value by calling the API for obtaining a project ID and name.

Constraints: N/A

Range: N/A

Default Value: N/A

key_id

Yes

String

Definition: API key ID. You can obtain the value by calling the API for querying the API key list.

Constraints: N/A

Range: N/A

Default Value: N/A

id

No

String

Definition: API key ID. You can obtain the value by calling the API for querying the API key list.

Constraints: The value cannot be modified.

Range: N/A

Default Value: N/A

description

No

String

Definition: Description of the API key. A string of up to 100 characters.

Constraints: N/A

Range: N/A

Default Value: Empty string.

allow_all

Yes

Boolean

Definition: Specifies whether access is allowed from all IP addresses.

Constraints: N/A

Range:

• true: No IP address restrictions.

• false: Access is restricted by IP address.

Default Value: true

ip_whitelist

No

Array of strings

Definition: The API key IP address whitelist is a security feature in Huawei Cloud Model as a Service (MaaS) that restricts the use of an API key to specified IP addresses when calling model services. This helps prevent unauthorized use if the API key is compromised. Example values:

• Single IP address (e.g., 192.168.1.1);

• IP address range (e.g., 192.168.1.10-192.168.1.100);

• CIDR block (e.g., 192.168.10.0/24).

Constraints:

• Number of entries ≤ 100;

• Each IP address must be a valid IPv4 address. CIDR format is supported (e.g., 192.168.0.0/24);

• Duplicate IP addresses are not allowed;

• CIDR subnet masks must be valid and contiguous;

• This field must be empty when allow_all=true.

IP address validation rules:

1. IP octet validation: Each IPv4 octet must be a valid decimal integer between 0 and 255.

2. IP address format and subnet mask validation:

   • The overall format must match the regular expression for x.x.x.x or x.x.x.x/y.

   • If a subnet mask is specified, its value must be between 0 and 32.

   • Special rule: The subnet mask prefix length must be greater than or equal to the position of the rightmost 1 bit in the 32-bit binary representation of the IP address (that is, the mask must not truncate the IP address's significant bits).

3. IP address comparison rule: To compare two IP addresses, compare their numerical values segment by segment from left to right (most significant to least significant) to determine their relative order.

4. IP range validation: A valid IP range must contain exactly two IP addresses. Both addresses must pass the format and subnet mask validation rules described above, and the starting IP address must be less than or equal to the ending IP address.

resident_model_version_whitelist

No

ResidentModelVersionWhitelist object

Definition: Whitelist of resident model versions, which restricts the resident model versions that can be accessed.

Range: N/A

endpoint_whitelist

No

EndpointWhitelist object

Definition: Whitelist of endpoints, which restricts the endpoints that can be accessed.

Range: N/A

overall

No

String

Definition: Model service scope (including the model services and their versions) where the API key takes effect.

Constraints: N/A

Range:

1. all: The API key takes effect for all model services.

2. Empty string: The API key does not take effect for all model services.

Default Value: Empty string.

whitelist

No

Array of Whitelist objects

Definition: Whitelist of resident model versions. Each entry specifies a resident model and its version that can be accessed.

Range: Whitelist object array. For details, see the field breakdown below.

resident_model_id

No

String

Definition: Resident model ID. The following uses the Chrome browser as an example to describe how to obtain the resident model ID:

On the Real-Time Inference > Built-in Services page in the MaaS console, press F12 to open DevTools. Choose the Network tab and search for query. Click the entry whose name starts with query?business_type=payment. In the Response tab, search for the desired model name, such as DeepSeek-V4.1-Flash. The value of the resident_model_id parameter is the resident model ID.

Constraints: N/A

Range: N/A

Default Value: N/A

version_whitelist

No

String

Definition: Whitelisted versions of the resident model that can be accessed. Separate multiple versions with commas (,). The following uses the Chrome browser as an example to describe how to obtain the resident model version name:

On the Real-Time Inference > Built-in Services page in the MaaS console, press F12 to open DevTools. Choose the Network tab and search for query. Click the entry whose name starts with query?business_type=payment. In the Response tab, search for the desired model name, such as DeepSeek-V4.1-Flash. The ID of the data whose version_name is DeepSeek-V4.1-Flash under version_list is the resident model version.

Constraints: N/A

Range: N/A

Default Value: N/A

overall

No

String

Definition: Overall bypass policy.

Constraints: N/A

Range: The value "all" indicates that all requests are allowed to bypass. An empty string indicates that the overall bypass function is disabled.

Default Value: Empty string.

whitelist

No

Array of strings

Definition: Whitelist of endpoint IDs. Only the endpoints in the whitelist can be accessed. You can obtain the ID by calling the API for querying endpoints.

Constraints: N/A

id

String

Definition: Unique ID of an API key, which is automatically generated by the system.

Range: N/A

api_key

String

Definition: Plaintext of the original API key generated by the inference service (returned only once during creation). A string of up to 255 characters.

Range: N/A

label

String

Definition: Display name of the API key, which is the same as the label in the request.

Range: N/A

description

String

Definition: Description of the API key, which is the same as the description in the request. A string of up to 100 characters.

Range: N/A

allow_all

Boolean

Definition: Specifies whether access is allowed from all IP addresses.

Range:

• true: No IP address restrictions.

• false: Access is restricted by IP address.

ip_whitelist

Array of strings

Definition: IP address whitelist. The effective value is displayed in the command output.

Range: N/A

resident_model_version_whitelist

ResidentModelVersionWhitelist object

Definition: Whitelist information of the resident model version, which is the same as the value in the request.

Range: N/A

endpoint_whitelist

EndpointWhitelist object

Definition: Whitelist information of the endpoint, which is the same as the value in the request.

Range: N/A

overall

String

Definition: Model service scope (including the model services and their versions) where the API key takes effect.

Range:

1. all: The API key takes effect for all model services.

2. Empty string: The API key does not take effect for all model services.

whitelist

Array of Whitelist objects

Definition: Whitelist of resident model versions. Each entry specifies a resident model and its version that can be accessed.

Range: Whitelist object array. For details, see the field breakdown below.

resident_model_id

String

Definition: Resident model ID. The following uses the Chrome browser as an example to describe how to obtain the resident model ID:

On the Real-Time Inference > Built-in Services page in the MaaS console, press F12 to open DevTools. Choose the Network tab and search for query. Click the entry whose name starts with query?business_type=payment. In the Response tab, search for the desired model name, such as DeepSeek-V4.1-Flash. The value of the resident_model_id parameter is the resident model ID.

Range: N/A

version_whitelist

String

Definition: Whitelisted versions of the resident model that can be accessed. Separate multiple versions with commas (,). The following uses the Chrome browser as an example to describe how to obtain the resident model version name:

On the Real-Time Inference > Built-in Services page in the MaaS console, press F12 to open DevTools. Choose the Network tab and search for query. Click the entry whose name starts with query?business_type=payment. In the Response tab, search for the desired model name, such as DeepSeek-V4.1-Flash. The ID of the data whose version_name is DeepSeek-V4.1-Flash under version_list is the resident model version.

Range: N/A

overall

String

Definition: Overall bypass policy.

Range: The value "all" indicates that all requests are allowed to bypass. An empty string indicates that the overall bypass function is disabled.

whitelist

Array of strings

Definition: Whitelist of endpoint IDs. Only the endpoints in the whitelist can be accessed. You can obtain the ID by calling the API for querying endpoints.

error_msg

String

Definition: Error message.

Range: N/A

error_code

String

Definition: Error code.

Range: N/A

200

API key modified.

403

The user authentication token is abnormal.