Taking Services Offline in Batches

Function

Bring offline in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/design/approvals/batch-offline

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens.
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Project-Id	No	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios.
Content-Type	No	String	Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
biz_infos	Yes	Array of BizInfoVO objects	Service information list.
approver_user_id	Yes	String	Approver ID.
approver_user_name	Yes	String	Approver name.
email	No	String	Email address of the approver. This parameter is set only when the approver is created.
fast_approval	No	Boolean	Quick approval, which is an informal scenario and is used for quick experience. This function is provided only when the current user has the approval permission.
schedule_time	No	String	Job scheduling time. For example, 30_18, indicating 18:30.
env_type	No	String	Type of the development and production environment. Options: INVALID_TYPE: invalid environment DEV_TYPE: development environment PROD_TYPE: production environment DEV_PROD_TYPE: development and production environment

**Table 4** BizInfoVO
Parameter	Mandatory	Type	Description
biz_id	Yes	String	Business ID, which is a string
biz_type	Yes	String	Business entity type. Options: AGGREGATION_LOGIC_TABLE: summary table ATOMIC_INDEX: atomic metric ATOMIC_METRIC: atomic metric (new) BIZ_CATALOG: process architecture directory BIZ_METRIC: service indicator CODE_TABLE: code table COMMON_CONDITION: general filter COMPOSITE_METRIC: Compound Metric (new) COMPOUND_METRIC: compound metric CONDITION_GROUP: restriction group DEGENERATE_DIMENSION: degenerate dimension DERIVATIVE_INDEX: derivative indicator DERIVED_METRIC: derivative indicator (new) DIMENSION: dimension DIMENSION_ATTRIBUTE: dimension attribute DIMENSION_HIERARCHIES: dimension level DIMENSION_LOGIC_TABLE: dimension table DIMENSION_TABLE_ATTRIBUTE: dimension attribute DIRECTORY: directory FACT_ATTRIBUTE: fact table attribute FACT_DIMENSION: fact table dimension FACT_LOGIC_TABLE: fact table FACT_MEASURE: fact table measurement FUNCTION: function INFO_ARCH: information architecture (used for modifying themes in batches) MODEL: model QUALITY_RULE: quality rule SECRECY_LEVEL: security level STANDARD_ELEMENT: data standard STANDARD_ELEMENT_TEMPLATE: data standard template SUBJECT: theme Dimension attributes of SUMMARY_DIMENSION_ATTRIBUTE: summary tables SUMMARY_INDEX: summary table indicator attribute SUMMARY_TIME: time period attribute of the SDR table TABLE_MODEL: relationship model (logical model/physical model) TABLE_MODEL_ATTRIBUTE: relationship model attribute (logical model/physical model) TABLE_MODEL_LOGIC: logical entity TABLE_TYPE: table type TAG: tag TIME_CONDITION: time restriction
env_type	No	String	Type of the development and production environment. Options: INVALID_TYPE: invalid environment DEV_TYPE: development environment PROD_TYPE: production environment DEV_PROD_TYPE: development and production environment

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data	data object	Number of successful batch offline results.

**Table 6** data
Parameter	Type	Description
value	BatchOperationVO object	Returned result of the batch offline operation.

**Table 7** BatchOperationVO
Parameter	Type	Description
id	String	Batch approval ID, which is a string
tenant_id	String	Project ID.
group_id	String	Group ID, which is a string
biz_name	String	Service name.
biz_id	String	Business ID, which is a string
operation_status	String	Operation result type enumeration. RUNNING(Running), SUCCESS(Operation succeeded), and FAILED(Operation failed). Options: RUNNING: The task is running. SUCCESS: The operation is successful. FAILED: The operation fails.
operation_type	String	Indicates the type.
biz_info	String	Service details.
create_by	String	Creator.
remark	String	Indicates the remark information.
total	Integer	Total number.
success	Integer	Number of successful operations.
failed	Integer	Indicates the number of failed operations.
rate	String	Indicates the current progress.
logs	String	Logs.
groups	Array of BatchOperationVO objects	Group information.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DS.6000, indicating that the request fails to be processed.
error_msg	String	Error message
data	Object	Returned data information.

Example Requests

Bring physical tables offline in batches based on parameters such as physical table IDs.

POST https://{endpoint}/v2/{project_id}/design/approvals/batch-offline?from=standard

{
  "biz_infos" : [ {
    "biz_id" : "1229920251379118081",
    "biz_type" : "TABLE_MODEL"
  }, {
    "biz_id" : "1222853173564289024",
    "biz_type" : "TABLE_MODEL"
  } ],
  "approver_user_id" : "0833a573fe80d5401f6dc010a775569a",
  "approver_user_name" : "test_uesr",
  "email" : null,
  "fast_approval" : true
}

Example Responses

Status code: 200

This operation succeeds, and the returned data is the BatchOperationVO object. The batch object is in the BatchOperationVO.group attribute.

{
  "data" : {
    "value" : {
      "id" : null,
      "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
      "group_id" : "1230939932055457792",
      "biz_name" : null,
      "biz_id" : null,
      "operation_status" : "SUCCESS",
      "operation_type" : "OFFLINE",
      "biz_info" : null,
      "create_by" : "test_uesr",
      "remark" : null,
      "total" : 2,
      "success" : 2,
      "failed" : 0,
      "rate" : "1.00",
      "logs" : null,
      "groups" : [ {
        "id" : "1230939939395489792",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "group_id" : "1230939932055457792",
        "biz_name" : "test_czh_0416",
        "biz_id" : "1229920251379118081",
        "operation_status" : "SUCCESS",
        "operation_type" : "OFFLINE",
        "biz_info" : "{}",
        "create_by" : "test_uesr",
        "remark" : "PASSED",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : null
      }, {
        "id" : "1230939939395489793",
        "tenant_id" : "0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3",
        "group_id" : "1230939932055457792",
        "biz_name" : "test_czh_0328",
        "biz_id" : "1222853173564289024",
        "operation_status" : "SUCCESS",
        "operation_type" : "OFFLINE",
        "biz_info" : "{}",
        "create_by" : "test_uesr",
        "remark" : "PASSED",
        "total" : 0,
        "success" : 0,
        "failed" : 0,
        "rate" : null,
        "logs" : null,
        "groups" : null
      } ]
    }
  }
}

Status code: 400

BadRequest

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user request is illegal."
}

Status code: 401

Unauthorized

{
  "error_code" : "DS.60xx",
  "error_msg" : "User authentication failed."
}

Status code: 403

Forbidden

{
  "error_code" : "DS.60xx",
  "error_msg" : "The user does not have permission to call this API."
}

Status code: 404

Not Found

{
  "error_code" : "DS.60xx",
  "error_msg" : "The User Request API does not exist."
}

Status Codes

Status Code	Description
200	This operation succeeds, and the returned data is the BatchOperationVO object. The batch object is in the BatchOperationVO.group attribute.
400	BadRequest
401	Unauthorized
403	Forbidden
404	Not Found