Obtaining Records Based on the Component ID

Function

This API is used to obtain records based on the component ID.

Authorization Information

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

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permission listed below is required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

servicestage:app:listComponent

list

-

-

servicestage:app:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:app:listComponent	list	-	-	servicestage:app:list	-

URI

GET /v3/{project_id}/cas/applications/{application_id}/components/{component_id}/records

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
application_id	Yes	String	Definition Application ID. See Obtaining All Applications. Constraints N/A Range N/A Default Value N/A
component_id	Yes	String	Definition Component ID. See Obtaining All Components of an Application. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of query results. Constraints N/A Range 1~100 Default Value 10
offset	No	Integer	Definition Query offset, which indicates the result after the Nth data record is queried. Constraints N/A Range N/A Default Value 0
order_by	No	String	Definition Sorting field. Constraints N/A Range create_time: component creation time. name: component name. update_time: component modification time. If the transferred value is not within the supported enumerated value range, the data is sorted by create_time. Default Value create_time
order	No	String	Definition Sorting order. Constraints N/A Range desc: descending order asc: ascending order Default Value desc

Request

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. Constraints N/A Range N/A Default Value N/A

Response

**Table 4** Response parameters
Parameter	Type	Description
count	Integer	Definition Total number of records. Range N/A
records	Array of objects	Definition Record list. See Table 5.

**Table 5** records parameters
Parameter	Type	Description
begin_time	String	Definition Start time. Range N/A
end_time	String	Definition End time. Range N/A
description	Object	Definition Description. Range N/A
instance_id	String	Definition Instance ID. Range N/A
version	String	Definition Version number. Range N/A
current_used	Boolean	Definition Whether it is used currently. Range true: yes false: no
status	String	Definition Status. Range RUNNING FAILED SUCCEEDED
deploy_type	String	Definition Deployment type. Range OneBatchRelease RollingRelease GrayRelease
jobs	Array of objects	Definition Job list. See Table 6.

**Table 6** jobs
Parameter	Type	Description
sequence	Integer	Definition Execution sequence. Range N/A
deploy_type	String	Definition Deployment type. Range OneBatchRelease RollingRelease GrayRelease
job_id	String	Definition Task ID. Range N/A
job_info	Object	Definition Job information. See Table 7.

**Table 7** job_info
Parameter	Type	Description
deploy_type	String	Definition Deployment type. Range OneBatchRelease RollingRelease GrayRelease
source_url	String	Definition Component source. Range N/A
first_batch_weight	Integer	Definition First execution weight. Range N/A
first_batch_replica	Integer	Definition Component instances deployed first time. Range N/A
replica	Integer	Definition Total instances. Range N/A
remaining_batch	Integer	Definition Remaining batch. Range N/A

Example Request

None

Example Response

{
  "count": 10,
  "records": [
    {
      "begin_time": "string",
      "end_time": "string",
      "description": null,
      "instance_id": "string",
      "version": "string",
      "current_used": true,
      "status": "string",
      "deploy_type": "string",
      "jobs": [
        {
          "sequence": 0,
          "deploy_type": "string",
          "job_id": "string",
          "job_info": {
            "deploy_type": "string",
            "source_url": "string",
            "first_batch_weight": 0,
            "first_batch_replica": 0,
            "replica": 0,
            "remaining_batch": 0
          }
        }
      ]
    }
  ]
}

Status Code

Status Code	Description
200	OK
400	Bad Request
404	Not Found
500	Internal Server Error

Error Code

See ServiceStage Error Codes.

Parent topic: Component

Previous topic: Delivering a Component Task Based on the Component ID

Next topic: Refreshing Component Information Based on the Component ID