Help Center> Cloud Stream Service> API Reference> APIs> APIs Related to Job Management> Querying the APIG Address of a Job
View PDF

Querying the APIG Address of a Job

Function

This API is used to query the APIG address of a job.

URI

  • URI format

    GET /v1.0/{project_id}/job/{job_id}/apig_sinks

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

    job_id

    Yes

    Job ID.

Request

None

Response

  • Example response 
    {
  "message_id": "CS.10001",
"message": "Message content",
  "current_time": 3423423423,
  "payload": {
    "sinks": [
      {
        "app_id": "ee412697e20c4ab8b567bffd71724991",
        "sink_name": "CAR_INFOS_DETAIL",
        "url": "https://fb2ce37f71f04d91ac67c4efcd75a172.apigw.cn-north-1.huaweicloud.com/jobid/CAR_INFOS_DETAIL"
        
        
      }
    ],
    "metadata": [
      {
        "name": "CAR_INFOS_DETAIL",
        "encode": "csv",
        "delimiter": ",",
        "attrs": [
          {
            "name": "car_id",
            "type": "STRING"
          }
        ]
      }
    ]
  }
}
  • Parameter description
    Table 2 Response parameters

    Parameter

    Mandatory

    Type

    Description

    message_id

    No

    String

    Message type ID.

    message

    No

    String

    Message content.

    current_time

    No

    Int

    Current time, expressed by milliseconds.

    payload

    No

    None

    Information about the job audit log.

    sinks

    No

    None

    Information about the APIG address of the job.

    app_id

    No

    String

    Application ID output by the sink stream of the job.

    sink_name

    No

    String

    Name of the sink stream of the job.

    url

    No

    String

    APIG address of the sink stream of the job.

    metadata

    No

    None

    Metadata information output by the sink stream.

    name

    No

    String

    Name of the sink stream of the job.

    encode

    No

    String

    Format of the sink stream of the job, for example, CSV.

    delimiter

    No

    String

    Delimiter of the sink stream of the job, for example, comma (,).

    attrs

    No

    None

    Attribute information of the sink stream of the job.

    name

    No

    String

    Attribute name of the sink stream of the job.

    type

    No

    String

    Attribute type of the sink stream of the job.

Status Code

Table 3 Status code

Status Code

Description

200

The query of the APIG address of the job succeeds.

400

The input parameters are invalid.

Error Code

For details, see Error Codes.