Help Center/ Huawei Cloud Astro Zero/ API Reference/ APIs/ Flows/ Querying Flows or Flow Input and Output Parameters by Flow_id

Updated on 2025-08-14 GMT+08:00

View PDF

Querying Flows or Flow Input and Output Parameters by Flow_id

Function

This API is used to query the input and output parameters of a flow instance.

URI

GET Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/Flow/{flow_id}

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
flow_id	Yes	String	Explanation Flow instance ID, which can be queried by calling the API of Querying Flows (id in the response message) Constraints None Value None Default value None

Request Parameters

**Table 2** Request parameter
Parameter	Mandatory	Type	Description
flag	No	String	Explanation Flow query mode. Constraints None Value There are four cases: If flag is not passed in the request, the request is used to query the flow instance specified by flow_id. If flag=check is carried, the request is used to query the flow instance specified by flow_id. If flag=Describe is carried, the request is used to query the input and output parameters of the flow instance specified by flow_id. If flag=dep is carried, the request is used to query the dependent object instances of the flow instance specified by flow_id. Default value None

Response Parameters

**Table 3** Response parameters
Parameter	Type	Description
resCode	String	Explanation Return code. Value If the request is successful, 0 is returned. For details about other error codes, see Error Codes.
resMsg	String	Explanation Message returned. Value If the request is successful, "Success" is returned. In other cases, an error message is returned.
result	Object	Explanation If the operation is successful, the service orchestration information is returned.

Example Request

This API is used to query the input and output parameters of a flow instance.

GET https://Huawei Cloud Astro Zero domain name/u-route/baas/metadata/v1.0/Flow/000y000000aM8XixTN0S

Example Response

{
    "resCode": "0",
    "resMsg": "Success",
    "result": {
        "active": false,
        "catalogue": "",
        "compilerVersion": 0,
        "createdBy": "testUserId",
        "createdBy.__objectType": "User",
        "createdBy.name": "test0xx",
        "createdDate": "2019-08-03 18:19:13",
        "custom": true,
        "description": "",
        "event": "",
        "eventCriteria": "",
        "id": "testId",
        "installedPackage": null,
        "interviewLabel": "",
        "label": "A Brand New Label",
        "lastModifiedBy": "testUserId",
        "lastModifiedBy.__objectType": "User",
        "lastModifiedBy.name": "test0xx",
        "lastModifiedDate": "2019-08-04 17:57:29",
        "localUrl": "",
        "lockUser": "",
        "name": "testName",
        "owner": "testUserId",
        "owner.__objectType": "User",
        "owner.name": "test0xx",
        "private": false,
        "processType": "",
        "protectMode": 0,
        "reserved": 0,
        "startElement": "",
        "status": "Error",
        "usingSLA": null,
        "version": "1.0.1"
    }
}