Updated on 2026-07-24 GMT+08:00

Deleting Specified Services

Function

This API is used to delete specified services. It is used when you need to clear resources, release compute, or manage multiple services. Before using this function, ensure that you have the permission to delete services and provide a valid service ID list. After the execution is successful, the specified services are stopped and related resources are released. If the service ID is invalid, the permission is insufficient, or the service status does not allow deletion, an error message is returned.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    modelarts:service:delete

    Write

    service *

    -

    -

    -

URI

POST /v2/{project_id}/services/delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID and Name.

Constraints

N/A

Range

Project ID.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain the token, see Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Message body type or format.

Constraints

N/A

Range

  • application/json

  • application/json;charset=utf-8

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

service_ids

Yes

Array of strings

Definition

List of service IDs to be deleted. Service ID, which can be obtained from the response body during service creation or by obtaining services owned by the current user. The service_id field is the service ID.

Constraints

N/A

Range

Service ID.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

service_responses

Array of ServiceResponse objects

Definition

Service response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 5 ServiceResponse

Parameter

Type

Description

id

String

Definition

Service ID, which can be obtained from the response body during service creation or by obtaining services owned by the current user. The service_id field is the service ID.

Range

N/A

name

String

Definition

Service name, which is customized when you create a service.

Range

The value can contain at most 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

workspace_id

String

Definition

Workspace ID.

Range

  • 0: default workspace ID.

  • 32 characters consisting of digits and lowercase letters. For details about other space IDs, see Creating a Workspace.

type

String

Definition

Inference service type.

Range

  • REAL_TIME: real-time service

  • ASYNC_REAL_TIME: asynchronous service

deploy_type

String

Definition

Deployment mode.

Range

  • SINGLE: single-node single-PU

  • MULTI: multi-node multi-PU

status

String

Definition

Service status.

Range

  • DEPLOYING

  • FAILED

  • STOPPED

  • RUNNING

  • DELETING

  • STOPPING

  • CONCERNING: There is an alarm.

  • UPGRADING

  • ERROR: abnormal

  • INIT: to be deployed

failure_reason

String

Definition

Reason why the real-time service fails.

Range

N/A

version

ServiceVersionResponse object

Definition

Current service version.

predict_url

Array of PredictUrlResponse objects

Definition

Access address of the real-time service. No value is returned by the service creation API. The value is returned by the details API.

dispatcher_group_id

String

Definition

ID of the dispatcher group associated with the service. No value is returned by the service creation API. The value is returned by the details API.

Range

N/A

tags

Array of TagsResponse objects

Definition

TMS tags.

deploy_timeout_minutes

Integer

Definition

Deployment timeout.

schedule

Array of ScheduleConfigResponse objects

Definition

Scheduled stop configuration.

create_at

String

Definition

Creation time, which is automatically generated.

Range

Millisecond-level timestamp, which is a 13-digit number, for example, 1609459200000.

update_at

String

Definition

Update time, which is automatically generated.

Range

Millisecond-level timestamp, which is a 13-digit number, for example, 1609459200000.

task_type

String

Definition

Model type.

Range

  • TEXT_GENERATION

  • IMAGE_UNDERSTANDING

  • VIDEO_GENERATION

  • IMAGE_GENERATION

  • RERANK

  • VECTOR_MODEL

  • EMBEDDING

provider

String

Definition

Account ID of the service provider, which can be obtained by parsing the IAM token from the X-Auth-Token-Provider request header during service creation. If this parameter is not left blank, you need to add X-Auth-Token-Provider to the request header for all update operations on the service. In this case, the value is domain-level or project-level token of the account ID.

frozen_infos

Array of FrozenInfo objects

Definition

Freezing type returned when a service or deployment is frozen.

Table 6 ServiceVersionResponse

Parameter

Type

Description

id

String

Definition

Version ID.

Range

N/A

version

String

Definition

Version number.

Range

N/A

description

String

Definition

Description.

Range

N/A

predict_url

String

Definition

Inference request URL.

Range

N/A

runtime_config

RuntimeConfigResponse object

Definition

Service runtime settings.

upgrade_config

UpgradeConfigResponse object

Definition

Service upgrade settings.

instance_groups

Array of GroupConfigResponse objects

Definition

Service deployment information.

lts_strategy

String

Definition

Log policy.

Range

  • POOL: Use the log stream configured by the resource pool log plug-in.

  • AUTO_CREATE: Automatically create a log stream.

  • DEFAULT: The system determines the log policy.

lts_status

String

Definition

Status of the interconnection between the deployment and LTS.

Range

  • ON: enabled

  • OFF: disabled

lts_event_status

String

Definition

Status of the interconnection between the deployment and LTS Kubernetes events.

Range

  • ON: enabled

  • OFF: disabled

log_configs

Array of LogConfigResponse objects

Definition

Service log configuration information.

deploy_timeout_minutes

Integer

Definition

Deployment timeout.

Range

N/A

Table 7 RuntimeConfigResponse

Parameter

Type

Description

service_invoke

ServiceInvokeResponse object

Definition

Service call configuration.

service_limit

ServiceLimitResponse object

Definition

Service constraints.

Constraints

N/A

service_secret

ServiceSecretResponse object

Definition

Service secret volume mounting.

server_task_limit

ServerTaskLimit object

Definition

Service task restriction information.

Table 8 ServiceInvokeResponse

Parameter

Type

Description

port

Integer

Definition

Service port number.

Range

[1, 65535]

protocol

String

Definition

Service request protocol. When WSS or WS is selected, the service API is upgraded to WebSocket. WebSocket cannot be enabled together with Traffic Limit.

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

  • WSS: WebSocket Secure protocol

  • WS: WebSocket protocol

auth_type

String

Definition

Authentication type.

Range

  • TOKEN: IAM token authentication.

  • API_KEY: API key authentication.

  • NONE: No authentication.

internet_access_enable

Boolean

Definition

External network access.

Range

  • TRUE: External network access is enabled.

  • FALSE: External network access is disabled.

intranet_approval_enable

Boolean

Definition

Private network approval.

Range

  • TRUE: Private network approval is required.

  • FALSE: Private network approval is disabled.

dynamic_routing_enable

Boolean

Definition

Dynamic route switch.

Range

  • TRUE: Dynamic routing is enabled.

  • FALSE: Dynamic routing is disabled.

strategy

String

Definition

Intelligent routing policy.

Range

  • ROUND_ROBIN: round robin

  • ORIGIN_IP_HASH: source IP hash

  • MIN_CONN: minimum number of connections

  • MIN_FIRST_TOKEN_TIME: minimum time to first token

  • COMPOSITE: overall loads

  • SLO_BASED: SLO priority

metric_api_scheme

String

Definition

Protocol of metric API service requests.

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

metric_api_port

String

Definition

Metric API port number.

Range

[1, 65535]

metric_api_path

String

Definition

Metric API path.

Range

N/A

ems_enable

Boolean

Definition

Specifies whether to enable EMS acceleration.

Range

  • TRUE: EMS acceleration is enabled.

  • FALSE: EMS acceleration is disabled.

request_retry_enable

Boolean

Definition

Specifies whether the proxy supports request rescheduling.

Range

  • true: The proxy supports request rescheduling.

  • false: The proxy does not support request rescheduling.

request_retry_cnt_max

Integer

Definition

Maximum number of retries supported by the proxy for request rescheduling.

Range

[1, 10]

request_retry_interval_ms

Integer

Definition

Retry interval supported by the proxy for request rescheduling, in milliseconds.

Range

[1, 10000]

fuse_configs

FuseConfig object

Definition

Circuit breaker configuration.

Range

N/A

Table 9 FuseConfig

Parameter

Type

Description

error_rate_fuse_enable

Boolean

Definition

Error-rate circuit breaker switch.

Constraints

N/A

Range

true: Enable error-rate circuit breaker.

false: Disable error-rate circuit breaker.

Default Value

false: Disable error-rate circuit breaker.

error_rate_threshold

Float

Definition

Error-rate circuit breaker threshold.

Constraints

N/A

Range

(0, 1] (The value can contain a maximum of two decimal places. The third decimal place is rounded off.)

Default Value

N/A

Table 10 ServiceLimitResponse

Parameter

Type

Description

rate_limit

RateLimitResponse object

Definition

Metrics related to traffic control.

request_size_limit

Integer

Definition

Request size limit.

Range

1–50M

request_timeout

Integer

Definition

Timeout interval.

Range

1 to 7,200 seconds

ip_white_list

Array of strings

Definition

IP address whitelist.

ip_black_list

Array of strings

Definition

IP address blacklist.

Table 11 RateLimitResponse

Parameter

Type

Description

num

Integer

Definition

Maximum number of times a service can be accessed within a unit.

Range

1 to 10000

unit

String

Definition

Traffic limiting unit.

Range

  • NANOS (nanosecond)

  • MICROS (microsecond)

  • MILLIS (millisecond)

  • SECONDS (s)

  • MINUTES (min)

  • HOURS (hour)

  • DAYS (day)

Table 12 ServiceSecretResponse

Parameter

Type

Description

secret_enable

Boolean

Definition

Specifies whether to enable the key.

Range

  • true: The secret is enabled.

  • false: The secret is disabled.

secret_type

String

Definition

Secret type.

Range

  • custom: custom secret.

  • [dew: DEW secret.] (tag:hws,hws_hk,fcs)

secret_volumes

Array of SecretVolumeResponse objects

Definition

Secret volume mounting.

Constraints

Maximum: 30

group_enable

Boolean

Definition

Specifies whether to enable the image user group.

Range

  • true: The user group of the image is enabled.

  • false: The user group of the image is not enabled.

group_id

Long

Definition

User group ID of the image.

Range

1000 to 4294967294

Table 13 SecretVolumeResponse

Parameter

Type

Description

secret_name

String

Definition

Key name.

Range

N/A

secret_key

String

Definition

Secret key.

Range

The value contains up to 63 characters.

secret_value

String

Definition

Secret value.

Range

The value contains up to 32,768 characters.

mount_path

String

Definition

Mount path.

Range

N/A

Table 14 ServerTaskLimit

Parameter

Type

Description

max_task

Integer

Definition

Maximum number of total tasks for a single service.

Range

[0, 10000]

Table 15 UpgradeConfigResponse

Parameter

Type

Description

type

String

Definition

Upgrade type.

Range

  • ROLLING: rolling upgrade (default value)

rolling_update

RollingUpdateResponse object

Definition

Rolling update configuration.

Table 16 RollingUpdateResponse

Parameter

Type

Description

max_surge

String

Definition

Maximum number of pods that can be started during rolling update.

Range

N/A

max_unavailable

String

Definition

Maximum number of pods that can be deleted during rolling update.

Range

N/A

Table 17 GroupConfigResponse

Parameter

Type

Description

id

String

Definition

Deployment ID.

Range

N/A

name

String

Definition

Deployment name.

Range

N/A

pool_id

String

Definition

Resource pool ID. Services in a specified resource pool are queried. By default, no resource pool is filtered. You can obtain the value by querying the resource pool list.

Range

N/A

count

Integer

Definition

Number of service instances in the deployment scenario.

Constraints

N/A

Range

[1, 128]

Default Value

N/A

system_log_dump_enable

Boolean

Definition

Specifies whether to enable system log dump.

Constraints

This parameter is available only for NPU resource pools.

Range

N/A

Default Value

false

unit_configs

Array of UnitConfigResponse objects

Definition

Inference unit configuration.

weight

Integer

Definition

Weight percentage of the traffic allocated to the model. This parameter is mandatory only when the model is deployed as a real-time service.

Range

[0,100]

traffic_ratio

String

Definition

Traffic ratio, that is, the ratio of the expected user traffic to the total traffic of a single deployment instance. The value is calculated based on the traffic weight configuration and deployment status.

Range

0.00/ %to 100.00%

secret_type

String

Definition

Secret type. You can select the secret type (dew or agency) to be used here.

Constraints

N/A

Range

  • [dew: DEW secret.] (tag:hws,hws_hk,fcs)

  • agency: temporary agency credential.

Default Value

N/A

secret_name

String

Definition

Secret name. When using a DEW secret, you can select the secret to be used here.

Constraints

N/A

priority

Integer

Definition

Service priority.

Constraints

N/A

Range

[1, 3]

Default Value

N/A

high_avail_switch

Boolean

Definition

Specifies whether to enable HA. Once enabled, pods of different instances are evenly distributed to different nodes. (This parameter is about to be brought offline. Use the schedule_strategy field instead.)

Range

  • true: Enable HA.

  • false: Disable HA.

framework

String

Definition

Algorithm framework.

Range

  • COMMON: common real-time service.

version

String

Definition

Service version, which consists of digits and periods (.), for example, 1.0.1.

Constraints

N/A

Range

The value ranges from 1.0.0 to 99.99.99 and can contain at most eight characters.

Default Value

N/A

version_id

String

Definition

Version ID, which can be obtained by querying the version list.

Constraints

N/A

Range

N/A

Default Value

N/A

status

String

Definition

Service status.

Range

  • DEPLOYING

  • FAILED

  • STOPPED

  • RUNNING

  • DELETING

  • STOPPING

  • CONCERNING: There is an alarm.

  • DELETED

  • RESTARTING

  • UPGRADING

  • ERROR: abnormal

  • INTERRUPTING

running_count

Integer

Definition

Number of service running instances in the deployment scenario.

Constraints

N/A

Range

[1, 128]

Default Value

N/A

deploy_type

String

Definition

Deployment type.

Range

  • SINGLE: single-node single-PU

  • MULTI: multi-node multi-PU

mirror_traffic_enable

Boolean

Definition

Specifies whether to enable image traffic.

Range

N/A

mirror_traffic_weight

String

Definition

Image traffic weight.

Range

50.

version_count

Integer

Definition

Number of service versions.

Range

N/A

workload_type

String

Definition

Workload type.

Range

N/A

update_at

Long

Definition

Update time, which is automatically generated.

Range

Millisecond-level timestamp, which is a 13-digit number.

lts_state

String

Definition

Status of the interconnection between the deployment and LTS.

Range

  • ON: enabled

  • OFF: disabled

infer_name

String

Definition

Deployment ID.

model

InferModelResponse object

Definition

Model configuration. You can select a model and weight file to use with the image.

Constraints

N/A

advanced_config

AdvancedConfig object

Definition

Advanced deployment settings.

Constraints

N/A

description

String

Definition

Deployment description.

create_at

String

Definition

Creation time, which is automatically generated.

Range

Millisecond-level timestamp, which is a 13-digit number, for example, 1609459200000.

schedule_strategy

String

Definition

Scheduling policy.

Range

  • HIGH_AVAILABILITY: HA scheduling

  • HIGH_UTILIZATION: compact scheduling

  • HIGH_PERFORMANCE: high-performance scheduling

Table 18 UnitConfigResponse

Parameter

Type

Description

id

String

Definition

Instance unit ID.

Range

N/A

name

String

Definition

Instance unit name.

Range

N/A

role

String

Definition

Instance unit role.

Range

  • COMMON: other roles

custom_spec

CustomResourceSpec object

Definition

Custom resource specifications.

flavor

String

Definition

Resource specifications. Select specifications based on service requirements. When specification is set to custom, the custom specifications are used. custom_spec specifies deployment specifications.

Range

N/A

image

ImageInfoResponse object

Definition

Image configuration information, including the image path and image source.

models

Array of InferModelResponse objects

Definition

Model configuration. You can select a model and weight file to use with the image.

files

Array of FileResponse objects

Definition

Model and code configuration. You can select the model and weight file to work with the image and the OBS path where the code is stored.

codes

Array of CodeResponse objects

Definition

Code configuration. You can select the OBS path where the code is stored.

dumps

Array of DumpResponse objects

Definition

Dump configuration. You can select the OBS path where the data is to be dumped.

count

Integer

Definition

Number of configuration instances.

Range

N/A

group_count

Integer

Definition

Number of replicas in a unit. This parameter is invalid when deploy_type is set to SINGLE or workload_type is set to DEPLOYMENT.

Range

[1, 100] or left empty.

Default Value

1

cmd

String

Definition

Startup command.

Range

N/A

envs

Map<String,String>

Definition

Environment variable.

readiness_health

HealthResponse object

Definition

Readiness health check.

startup_health

HealthResponse object

Definition

Health checks are enabled.

liveness_health

HealthResponse object

Definition

Liveness health check.

port

Integer

Definition

Port.

Range

[1, 65535]

recovery

String

Definition

Auto-rebuild policy. When enabled, the platform will automatically rebuild pods according to the policy if they restart due to deployment configuration changes or hardware failures. If disabled, the platform will not intervene.

Range

  • Instance: Deployment replica rebuilding. Restarts the entire deployment when a fault occurs.

  • Role: Unit rebuilding. Restarts all pods within a deployment unit if any pod in that unit fails.

  • Pod: Pod rebuilding. Restarts the faulty pod if it fails.

npu_reset_enable

Boolean

Definition

Specifies whether to enable the recovery policy.

Range

  • true: The recovery policy is enabled.

  • false: The recovery policy is disabled.

affinity

AffinityResponse object

Definition

Node affinity scheduling.

flavor_display_name

String

Definition

Specification display name. This field is returned only for services deployed using the allocated specifications.

Range

N/A

termination_grace

TerminationGrace object

Definition

Once enabled, you can configure shutdown timeouts and commands. This prevents in-progress requests from being forcibly interrupted, thereby enhancing the availability and stability of the system.

Constraints

The value can contain up to 255 characters.

Range

  • Protocol: http or https

  • Port: 1 to 65535

  • Address: Only letters, digits, periods (.), hyphens (-), underscores (_), and slashes (/) are allowed. The value cannot start with a slash (/).

Default Value

N/A

security_config

ServiceSecurityConfig object

Definition

Settings for starting the service container.

Range

N/A

pool_resource_flavor

String

Definition

Node pool resource specifications.

Constraints

The value can contain only letters, digits, periods (.), hyphens (-), and underscores (_).

Range

The value can contain a maximum of 128 characters.

Default Value

N/A

Table 19 CustomResourceSpec

Parameter

Type

Description

gpu

Float

Definition

Number of GPUs.

Constraints

N/A

Range

The value can be a decimal. It cannot be smaller than 0, with the third decimal place is rounded off.

Default Value

N/A

memory

Integer

Definition

Memory size, in MB.

Constraints

N/A

Range

Only integers are supported.

Default Value

N/A

cpu

Float

Definition

CPU cores.

Constraints

N/A

Range

The value can be a decimal. It cannot be smaller than 0.01, with the third decimal place is rounded off.

Default Value

N/A

ascend

Integer

Definition

Number of Ascend chips.

Constraints

N/A

Range

N/A

Default Value

N/A

arch

String

Definition

Architecture type.

Constraints

N/A

Range

x86/arm64.

Default Value

N/A

Table 20 ImageInfoResponse

Parameter

Type

Description

id

String

Definition

Image ID.

Range

N/A

source

String

Definition

Image type, which indicates the image source.

Range

  • SWR: SoftWare Repository for Container (SWR)

swr_path

String

Definition

Image path. The address is different when the source value is different.

Range

N/A

category

String

Definition

Flavors supported by the image.

Range

  • GPU: graphics processing unit.

  • CPU: central processing unit.

  • ASCEND: Ascend chip.

Table 21 InferModelResponse

Parameter

Type

Description

source

String

Definition

Code source type.

Constraints

N/A

Range

The value is case-insensitive.

  • OBS: Object Storage Service

  • OBSFS: OBS file system API

  • EFS: Scalable File Service

  • LOCAL: local storage directory to which the host machine is mounted.

Default Value

N/A

address

String

Definition

Code source address, which complies with the format of different storage systems.

Constraints

N/A

Range

N/A

Default Value

N/A

source_id

String

Definition

Source ID.

Constraints

N/A

Range

N/A

Default Value

N/A

mount_path

String

Definition

Path mounted to the container. The value must start with a slash (/) and can contain hyphens (-), backslashes (), underscores (), periods (.), letters, and digits. Constraints N/A Range The value must start and end with a slash (/) and can contain at most 255 characters. Only letters, digits, hyphens (-), and underscores () are allowed.

Default Value

N/A

host_cache

Boolean

Definition

Specifies whether the model can be cached locally. This function is disabled by default.

Constraints

N/A

Range

  • true: supported.

  • false: not supported.

Default Value

false

efs_sub_path

String

Definition

When the storage type is EFS, subdirectories can be configured.

Constraints

N/A

Range

N/A

Default Value

N/A

read_only

Boolean

Definition

Specifies whether the mount permission is read-only.

Constraints

N/A

Range

  • true: read only

  • false: non-read-only

Default Value

N/A

os_warm_up

Boolean

Definition

OS warmup.

Constraints

N/A

Range

  • true: Warmup enabled.

  • false: Warmup disabled.

Default Value

N/A

source_name

String

Definition

Warmup name.

Constraints

This parameter is mandatory when os_warm_up is set to true.

Range

The value can contain at most 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

asset_id

String

Definition

Preset asset ID.

Constraints

This parameter is mandatory when preset assets are used.

Range

The value can contain at most 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

Table 22 FileResponse

Parameter

Type

Description

source

String

Definition

Code source type.

Range

  • OBS: Object Storage Service

  • OBSFS: OBS file system API

  • EFS: Scalable File Service

  • LOCAL: local storage directory to which the host machine is mounted.

address

String

Definition

Code source address, which complies with the format of different storage systems.

Range

N/A

mount_path

String

Definition

Path mounted to the container.

Constraints

N/A

Range

The value must start and end with a slash (/) and can contain at most 255 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

host_cache

Boolean

Definition

Specifies whether the model can be cached locally. This function is disabled by default.

Range

  • true: supported.

  • false: not supported.

efs_sub_path

String

Definition

When the storage type is EFS, subdirectories can be configured.

Range

N/A

read_only

Boolean

Definition

Specifies whether the mount permission is read-only.

Range

  • true: read only

  • false: non-read-only

os_warm_up

Boolean

Definition

OS warmup.

Range

  • true: Warmup enabled.

  • false: Warmup disabled.

source_name

String

Definition

Warmup name.

Constraints

This parameter is mandatory when os_warm_up is set to true.

Range

The value can contain at most 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

Table 23 CodeResponse

Parameter

Type

Description

source

String

Definition

Code source type.

Range

  • OBS: Object Storage Service

  • OBSFS: OBS file system API

  • EFS: Scalable File Service

address

String

Definition

Code source address, which complies with the format of different storage systems.

Range

N/A

source_id

String

Definition

Code source ID. Either this parameter or address must be specified. The SFS Turbo ID can be passed only when source is set to EFS.

Range

N/A

mount_path

String

Definition

Path mounted to the container.

Constraints

N/A

Range

The value must start and end with a slash (/) and can contain at most 255 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

efs_sub_path

String

Definition

EFS subpath.

Range

N/A

read_only

Boolean

Definition

Specifies whether the mount permission is read-only.

Range

  • true: read only

  • false: non-read-only

Table 24 DumpResponse

Parameter

Type

Description

source

String

Definition

Dump source type.

Range

  • OBS: Object Storage Service

  • OBSFS: OBS file system API

address

String

Definition

Dump source address, which complies with the format of different storage systems.

Range

N/A

mount_path

String

Definition

Path mounted to the container. The value must start with a slash (/) and can contain hyphens (-), backslashes (), underscores (_), periods (.), letters, and digits.

Range

N/A

type

String

Definition

Transfer type.

Range

  • DUMP: user-defined dump

  • DUMP_SYS: system dump

Table 25 HealthResponse

Parameter

Type

Description

check_method

String

Definition

Health check method, which can be HTTP or EXEC (commands).

Constraints

N/A

Range

  • HTTP: Hypertext Transfer Protocol

  • EXEC: commands

Default Value

N/A

cmd

String

Definition

Command line when the health check method is EXEC.

Constraints

The value can contain 0 to 1,024 characters and cannot contain the following characters: #~^$|%&*<>()'"[]{}

Range

N/A

Default Value

N/A

url

String

Definition

Request address when the health check mode is HTTP.

Constraints

The value can contain 0 to 1,024 characters. The first character must be a slash (/), and the subsequent characters can be letters, digits, hyphens (-), underscores (_), slashes (/), and colons (:).

Range

N/A

Default Value

N/A

protocol

String

Definition

Connection protocol. The default value is HTTP.

Constraints

N/A

Range

  • HTTPS: Hypertext Transfer Protocol Secure

  • HTTP: Hypertext Transfer Protocol

  • WSS: WebSocket Secure

  • WS: WebSocket

Default Value

N/A

initial_delay_seconds

Integer

Definition

Waiting time before the first detection. The default value is 30 and the minimum value is 1.

Constraints

N/A

Range

N/A

Default Value

30

timeout_seconds

Integer

Definition

Timeout interval of the detection. The default value is 30 seconds, and the minimum value is 1 second.

Constraints

N/A

Range

The minimum value is 1 second.

Default Value

30s

period_seconds

Integer

Definition

Interval at which the health check is performed. The default value is 10 seconds, and the minimum value is 1 second.

Constraints

N/A

Range

The minimum value is 1 second.

Default Value

10s

failure_threshold

Integer

Definition

The minimum number of consecutive detection failures required after a successful detection. Detection is considered failed only when this threshold is reached. The default value is 3. The minimum value is 1.

Constraints

N/A

Range

The minimum value is 1.

Default Value

3

Table 26 AffinityResponse

Parameter

Type

Description

affinity_type

String

Definition

Node affinity type.

Range

  • AFFINITY: affinity

  • ANTI_AFFINITY: anti-affinity

required

Boolean

Definition

Specifies whether to set strong affinity.

Range

  • true: Strong affinity is set.

  • false: Strong affinity is not set.

selection_mode

String

Definition

Node selection mode.

Range

IP.

targets

Map<String,String>

Definition

List selected using the preceding method, whose length cannot exceed 20.

Table 27 TerminationGrace

Parameter

Type

Description

pre_stop_cmd

String

Definition: The shutdown command is triggered when the container receives a stop signal, but it must be completed within the grace period or the shutdown times out. If this happens, the container will be forcefully stopped. You can use this command to perform operations such as closing database connections, releasing file handles, and stopping child processes.

Constraints

The value can contain up to 255 characters.

Range

  • Protocol: http or https

  • Port: 1 to 65535

  • Address: Only letters, digits, periods (.), hyphens (-), underscores (_), and slashes (/) are allowed. The value cannot start with a slash (/).

Default Value

N/A

termination_grace_period_seconds

Integer

Definition

This parameter indicates the maximum length of time that can pass between when a Pod receives a stop signal to when it is forcefully stopped. It is used for the Pod to perform cleanup operations (such as closing connections, releasing resources, and saving states).

Constraints

The value can contain up to 255 characters.

Range

  • Protocol: http or https

  • Port: 1 to 65535

  • Address: Only letters, digits, periods (.), hyphens (-), underscores (_), and slashes (/) are allowed. The value cannot start with a slash (/).

Default Value

N/A

Table 28 ServiceSecurityConfig

Parameter

Type

Description

user_id

Long

Definition

user_id set during service container startup. This parameter can be left empty by default.

Range

[1, 60000]

group_id

Long

Definition

group_id set during service container startup. This parameter can be left empty by default.

Range

[1, 60000]

Table 29 AdvancedConfig

Parameter

Type

Description

deploy_timeout_minutes

String

Definition

Deployment timeout.

upgrade_config

UpgradeConfig object

Definition

Rolling upgrade configuration.

service_secret

ServiceSecret object

Definition

Service secret.

dynamic_routing_enable

Boolean

Definition

Intelligent routing switch.

strategy

String

Definition

Intelligent routing policy.

ems_enable

Boolean

Definition

EMS acceleration switch.

metric_api_scheme

String

Definition

Intelligent routing metric collection scheme.

metric_api_port

String

Definition

Intelligent routing metric collection port.

metric_api_path

String

Definition

Intelligent routing metric collection URL.

custom_metrics_path

String

Definition

Custom metric collection URL.

port

Integer

Definition

Container port.

protocol

String

Definition

Container request protocol. When WSS or WS is selected, the service API is upgraded to WebSocket. WebSocket cannot be enabled together with Traffic Limit.

Range

  • HTTP: HTTP protocol

  • HTTPS: HTTPS protocol

  • WSS: WebSocket Secure protocol

  • WS: WebSocket protocol

  • TCP: Transmission Control Protocol

  • NA: No protocol used

Table 30 UpgradeConfig

Parameter

Type

Description

type

String

Definition

Upgrade type.

Constraints

N/A

Range

  • ROLLING: rolling upgrade (default value)

Default Value

N/A

rolling_update

RollingUpdate object

Definition

Rolling update configuration.

Constraints

N/A

Table 31 RollingUpdate

Parameter

Type

Description

max_surge

String

Definition

Maximum number of pods that can be started during rolling update.

Constraints

A percentage-type string.

Range

1/ %to 100%

Default Value

1%.

max_unavailable

String

Definition

Maximum number of pods that can be deleted during rolling update.

Constraints

A percentage-type string.

Range

1/ %to 100%

Default Value

1%.

Table 32 ServiceSecret

Parameter

Type

Description

secret_enable

Boolean

Definition

Specifies whether to enable the key.

Constraints

N/A

Range

  • true: The secret is enabled.

  • false: The secret is disabled.

Default Value

false

secret_type

String

Definition

Secret type.

Constraints

N/A

Range

  • custom: custom secret.

  • dew: DEW secret.

Default Value

N/A

secret_volumes

Array of SecretVolume objects

Definition

Secret volume mounting.

Constraints

Maximum: 30

group_enable

Boolean

Definition

Specifies whether to enable the image user group.

Constraints

N/A

Range

  • true: The user group of the image is enabled.

  • false: The user group of the image is not enabled.

Default Value

false

group_id

Long

Definition

User group ID of the image.

Constraints

N/A

Range

1000 to 4294967294

Default Value

N/A

Table 33 SecretVolume

Parameter

Type

Description

secret_name

String

Definition

Key name.

Constraints

N/A

Range

N/A

Default Value

N/A

secret_key

String

Definition

Secret key.

Constraints

A string of 1 to 63 characters is matched. Only letters, digits, dots (.), underscores (_), and hyphens (-) are allowed. The string cannot start with two consecutive dots (..).

Range

N/A

Default Value

N/A

secret_value

String

Definition

Secret value.

Constraints

The value is a Base64-encoded secret value and contains 1 to 32,768 characters.

Range

N/A

Default Value

N/A

mount_path

String

Definition

Mount path.

Constraints

N/A

Range

The value must start and end with a slash (/) and can contain at most 255 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default Value

N/A

Table 34 LogConfigResponse

Parameter

Type

Description

type

String

Definition

Log output type.

Range

  • STDOUT: Logs are output to the console or terminal.

  • EVENT: Kubernetes event.

status

String

Definition

Log service status.

Range

  • ON: enabled

  • OFF: disabled

log_group_id

String

Definition

Log group ID. You can select an existing log group. If this parameter is left blank, a log group is automatically created.

Constraints

N/A

Range

N/A

Default Value

N/A

log_stream_id

String

Definition

Log stream ID. You can select an existing log group. If this parameter is left blank, the system automatically creates one.

Constraints

N/A

Range

N/A

Default Value

N/A

deployment_id

String

Definition

ID of the deployment corresponding to the log stream. This parameter has a value when the log policy is default or pool.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 35 PredictUrlResponse

Parameter

Type

Description

type

String

Definition

Access mode.

Range

  • CONSOLE: Access through the console.

  • PUBLIC: Access through the public network.

  • INTERNAL: Access through the private network.

urls

Array of strings

Definition

Access address of an inference request. This parameter is only valid when type is set to REAL_TIME and the service is deployed.

Table 36 TagsResponse

Parameter

Type

Description

key

String

Definition

Tag key field.

Constraints

N/A

Range

The value can contain 1 to 128 characters. Only letters, digits, spaces, and special characters (_.:=+-@) are allowed. However, the value cannot start or end with a space or start with sys.

Default Value

N/A

value

String

Definition

Tag value field.

Range

The value can contain 255 characters. Only letters, digits, underscores (_), periods (.), slashes (/), equal signs (=), plus signs (+), minus signs (-), and at signs (@) are allowed.

Table 37 ScheduleConfigResponse

Parameter

Type

Description

due_time

Long

Definition

Trigger time. The value is a 13-digit timestamp, UTC time, in milliseconds.

Range

N/A

duration

Integer

Definition

Value mapping a time unit.

Range

N/A

time_unit

String

Definition

Scheduling time unit.

Range

  • MINUTES (min)

  • HOURS (hour)

  • DAYS (day)

type

String

Definition

Scheduling type. Only the value STOP is supported.

Range

  • STOP

processed

Boolean

Definition

Indicates whether the processing is complete.

Range

  • true: The scheduled task has been executed.

  • false: The scheduled task has not been executed.

Table 38 FrozenInfo

Parameter

Type

Description

scene

String

Freezing scenario. Options:

  • ARREAR: Frozen due to arrears

  • POLICE: frozen due to public security issues

  • ILLEGAL: Frozen due to abuse

effect

Integer

Impacts of freezing. Options:

  • 1: can be released after being frozen

  • 2: cannot be released after being frozen

Example Requests

This API is used to delete specified services based on the input service ID list.

POST https://{endpoint}/v2/{project_id}/services/delete

{
  "service_ids" : [ "example1", "example2", "example3" ]
}

Example Responses

Status code: 200

Deletion result response.

{
  "service_responses" : [ {
    "deploy_timeout_minutes" : 60,
    "deploy_type" : "MULTI",
    "failure_reason" : "",
    "id" : "8c49d60c-fb72-4445-8fd8-6683a17a14bb",
    "name" : "service-4633",
    "status" : "RUNNING",
    "type" : "REAL_TIME",
    "workspace_id" : "0"
  } ]
}

Status Codes

Status Code

Description

200

Deletion result response.

Error Codes

See Error Codes.