Querying a Feature Set by Snapshot Version
Function
This API is used to query a feature set by snapshot version.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
URI
GET /v1/ipdprojectservice/projects/{project_id}/feature-set/query
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition 32-character ID of a project, which must be unique. Obtain the value by calling the API for querying the IPD project list. The value of id in the response message body is the project ID. Constraints N/A Range A string of 32 characters consisting of letters and digits. Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| snapshot_version_id | No | String | Feature set snapshot version ID. If this parameter is not specified, the feature set of the current version is queried. If this parameter is specified, the feature set of the corresponding version is queried. |
Request Parameters
None
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| status | String | Definition Response status. Range |
| message | String | Message. |
| result | Array of FeatureSetOpenApiVO objects | Returned result. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Feature set ID. |
| number | String | No. |
| parent_id | String | Parent feature set ID. |
| title | String | Title. |
| position_float | String | Location information. |
| created_by | UserEntity object | Creator information. |
| modified_by | UserEntity object | Modifier information. |
| created_date | String | Definition Timestamp when a feature set is created. Range N/A |
| modified_date | String | Definition Timestamp when a feature set is modified. Range N/A |
| child_fs | Array of FeatureSetOpenApiVO objects | Sub-feature set. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Definition User ID. Obtain it by calling the API for querying project members. The value of id in the response message body is the user ID. Range N/A |
| name | String | Definition Username. Range 2 to 64 characters. |
| nick_name | String | Definition User alias. Range 2 to 30 characters |
Example Requests
-
Querying the feature set data of Snapshot Version 981644868612829184 in Project b7262b36cfa84b09a27f7896e1fdefc6
GET https://{endpoint}/v1/ipdprojectservice/projects/b7262b36cfa84b09a27f7896e1fdefc6/feature-set/query?snapshot_version_id=981644868612829184 -
Querying the feature set data of the current version of Project b7262b36cfa84b09a27f7896e1fdefc6
GET https://{endpoint}/v1/ipdprojectservice/projects/b7262b36cfa84b09a27f7896e1fdefc6/feature-set/query
Example Responses
Status code: 200
{
"status" : "success",
"message" : null,
"result" : [ {
"id" : "981644262727655424",
"number" : "FS20240401737948",
"parent_id" : null,
"title" : "mod1-min-0325-1 Feature Tree",
"position_float" : 2,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711971830000",
"modified_date" : "1711971830000",
"child_fs" : [ {
"id" : "978983008897904641",
"number" : "FS20240325720621",
"parent_id" : "981644262727655424",
"title" : "mod1-min-0325-1 Feature Tree",
"position_float" : 1,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711337337000",
"modified_date" : "1711971830000",
"child_fs" : [ {
"id" : "981644718250041344",
"number" : "FS20240401737949",
"parent_id" : "978983008897904641",
"title" : "1-1",
"position_float" : 1,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711971938000",
"modified_date" : "1711971938000",
"child_fs" : [ {
"id" : "981847412113842176",
"number" : "FS20240402738983",
"parent_id" : "981644718250041344",
"title" : "11",
"position_float" : 1,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1712020264000",
"modified_date" : "1712020264000",
"child_fs" : null
} ]
}, {
"id" : "981644750294523904",
"number" : "FS20240401737950",
"parent_id" : "978983008897904641",
"title" : "1-2",
"position_float" : 2,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711971946000",
"modified_date" : "1711971946000",
"child_fs" : [ {
"id" : "981644805718056960",
"number" : "FS20240401737951",
"parent_id" : "981644750294523904",
"title" : "1-2-1",
"position_float" : 1,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711971959000",
"modified_date" : "1711971959000",
"child_fs" : null
}, {
"id" : "981644911709302785",
"number" : "FS20240401738018",
"parent_id" : "981644750294523904",
"title" : "1-2-2",
"position_float" : 2,
"created_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"modified_by" : {
"id" : "a360371833bf4c558f796fd707b44daf",
"name" : "devcloud_devcloud_01",
"nick_name" : "Test account"
},
"created_date" : "1711971985000",
"modified_date" : "1711972027000",
"child_fs" : null
} ]
} ]
} ]
} ]
} SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; public class ShowBaselineSnapshotsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ShowBaselineSnapshotsRequest request = new ShowBaselineSnapshotsRequest(); request.withProjectId("{project_id}"); try { ShowBaselineSnapshotsResponse response = client.showBaselineSnapshots(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBaselineSnapshotsRequest() request.project_id = "{project_id}" response = client.show_baseline_snapshots(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := projectman.NewProjectManClient(hcClient) request := &model.ShowBaselineSnapshotsRequest{} request.ProjectId = "{project_id}" response, err := client.ShowBaselineSnapshots(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| Status Code | Description |
|---|---|
| 200 | Querying the response body of a feature set based on the snapshot version |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot