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
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

Displaying Batch Details

Updated on 2024-04-19 GMT+08:00

Function

This API is used to query batch details, which is used to obtain the instance list in a batch by page. Filter criteria: pagination parameter

URI

GET /v1/job/script/orders/{execute_uuid}/batches/{batch_index}

Table 1 Path parameters

Parameter

Mandatory or Not

Type

Description

batch_index

Yes

Integer

Batch index.

Minimum value: 1

Maximum value: 20

execute_uuid

Yes

String

Execution ID of a script service ticket, which is obtained from the response bodies of executeJobScript and ListJobScriptOrders.

Minimum length: 1 character

Maximum length: 26 characters

Table 2 Query parameters

Parameter

Mandatory or Not

Type

Description

status

No

String

Instance execution status. The options are as follows: READY: to be executed; PROCESSING: being executed; ABNORMAL: abnormal; CANCELED: canceled; FINISHED: successful.

The value can be:

  • READY
  • PROCESSING
  • ABNORMAL
  • CANCELED
  • FINISHED

limit

Yes

Integer

Pagination parameter: maximum number of records returned on each page.

Minimum value: 1

Maximum value: 50

marker

Yes

Long

Pagination parameter: ID of the last record on the previous page.

Minimum value: 0

Maximum value: 2147483647

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

batch_index

Integer

Batch index, starting from 1.

total_instances

Integer

Number of instances executed in a batch

execute_instances

Array of ExectionInstanceModel objects

Execution instance list, pagination

Table 4 ExectionInstanceModel

Parameter

Type

Description

id

Long

Primary key ID

target_instance

ResourceInstance object

New instance

gmt_created

Long

Creation time

gmt_finished

Long

Completion time

execute_costs

Long

Timeout interval, in seconds.

status

String

Instance execution status

The value can be:

  • READY
  • PROCESSING
  • ABNORMAL
  • CANCELED
  • FINISHED
  • ROLLBACKED

message

String

Instance execution logs

Table 5 ResourceInstance

Parameter

Type

Description

resource_id

String

Host ID of an ECS

agent_sn

String

Agent management ID

agent_status

String

Agent management status

properties

ResourceInstanceProp object

Additional attributes of the host

Table 6 ResourceInstanceProp

Parameter

Type

Description

host_name

String

Host name

fixed_ip

String

IP address of the internal network

floating_ip

String

Elastic IP Address (EIP)

region_id

String

Region ID

zone_id

String

AZ

application

String

CloudCMDB application. This parameter has a value only in the CloudCMDB application view, which is similar to the cloud services on the management plane.

group

String

CloudCMDB group. This parameter has a value only in the CloudCMDB application view, which is similar to the schema of the management plane.

project_id

String

Project ID of an instance.

Consumption is required. This parameter is mandatory.

Request Example

None

Response Example

Status code: 200

Response

{
  "data" : {
    "batch_index" : 1,
    "total_instances" : 1,
    "execute_instances" : [ {
      "id" : 1588,
      "target_instance" : {
        "resource_id" : "resource_id",
        "agent_sn" : "agent_sn",
        "agent_status" : null,
        "region_id" : null,
        "project_id" : null,
        "properties" : {
          "host_name" : "host_name",
          "fixed_ip" : "x.x.x.x",
          "floating_ip" : null,
          "region_id" : "cn-north-7",
          "zone_id" : "cn-north-7c",
          "application" : null,
          "group" : null,
          "project_id" : null
        }
      },
      "gmt_created" : 1697946452436,
      "gmt_finished" : 1697946763467,
      "execute_costs" : 311031,
      "status" : "CANCELED",
      "message" : "Script execution result"
    } ]
  }
}

Status Code

Status Code

Description

200

Response

Error code

See Error code.

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