Determining If a Task Uses Project-level Permissions
Function
This API is used to determine if a task uses project-level permissions.
Calling Method
For details, see Calling APIs.
URI
POST /v1/job/project/permission
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
job_id |
No |
String |
Definition Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL. Constraints N/A. Range The value is 32 characters long. Only letters and digits are allowed. Default Value N/A. |
|
project_id |
No |
String |
Definition CodeArts project ID. For details, seeObtaining a CodeArts Project ID. Constraints N/A. Range Use a 32-character string containing a mix of digits and letters. Default Value N/A. |
|
project_switch |
No |
Boolean |
Definition Whether the latest project permissions are synchronized. Constraints N/A. Range ● true: Project permissions are used. ● false: Project permissions are not used. Default Value N/A. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
status |
String |
Definition API response status. Range ● success: The API call is successful. ● fail: The API call failed. |
|
error |
Object |
Definition Error message. Range N/A. |
|
result |
String |
Definition Data returned after the API is successfully called. Range N/A. |
Example Requests
POST https://{endpoint}/v1/job/project/permission
{
"job_id" : "2f211929d0c543feb38824a665ad7fcb",
"project_id" : "6823252f543d4915b49892a5fd9f0ec3",
"project_switch" : true
}
Example Responses
Status code: 200
OK
{
"status" : "success"
}
SDK Sample Code
The SDK sample code is as follows.
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 49 50 |
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.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ApplyProjectPermissionSolution { 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); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ApplyProjectPermissionRequest request = new ApplyProjectPermissionRequest(); ProjectPermissionRequestBody body = new ProjectPermissionRequestBody(); body.withProjectSwitch(true); body.withProjectId("6823252f543d4915b49892a5fd9f0ec3"); body.withJobId("2f211929d0c543feb38824a665ad7fcb"); request.withBody(body); try { ApplyProjectPermissionResponse response = client.applyProjectPermission(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ApplyProjectPermissionRequest() request.body = ProjectPermissionRequestBody( project_switch=True, project_id="6823252f543d4915b49892a5fd9f0ec3", job_id="2f211929d0c543feb38824a665ad7fcb" ) response = client.apply_project_permission(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ApplyProjectPermissionRequest{} projectSwitchProjectPermissionRequestBody:= true projectIdProjectPermissionRequestBody:= "6823252f543d4915b49892a5fd9f0ec3" jobIdProjectPermissionRequestBody:= "2f211929d0c543feb38824a665ad7fcb" request.Body = &model.ProjectPermissionRequestBody{ ProjectSwitch: &projectSwitchProjectPermissionRequestBody, ProjectId: &projectIdProjectPermissionRequestBody, JobId: &jobIdProjectPermissionRequestBody, } response, err := client.ApplyProjectPermission(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank 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