Obtaining the Agency Credential for a Pod Identity Association
Function
This API is used to obtain the IAM agency credential for a pod identity association associated with a service account through the service account token.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
cce::assumeAgencyForPodIdentity
Write
-
-
-
-
URI
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/assume-agency-for-pod-identity
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
| cluster_id | Yes | String | Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A Default Value: N/A |
| X-Auth-Token | Yes | String | Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| token | Yes | String | Definition Service account token associated with a pod identity association Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| assumedAgency | AssumedAgency object | Definition Metadata of the agency corresponding to the credential. This attribute is returned only when a trust agency is configured for the pod identity association. Range N/A |
| audience | String | Definition The audience attribute passed when the credential is issued. If the credential is obtained using the pod identity association, the value is fixed at service.cce.pods. This attribute is returned only when a trust agency is configured for the pod identity association. Range N/A |
| credentials | Credentials object | Definition Credential details Range N/A |
| podIdentityAssociationId | String | Definition ID of the pod identity association that the agency credential belongs to Range N/A |
| subject | PodIdentitySubject object | Definition Service account information of an agency credential Range N/A |
| Parameter | Type | Description |
|---|---|---|
| urn | String | Definition Unique ID of an agency, in the format of sts::{account_id}::assumed-agency:{agency_name}/{agency_session_name} Range N/A |
| id | String | Definition Agency ID, in the format of {agency_id}:{agency_session_name} Range N/A |
| Parameter | Type | Description |
|---|---|---|
| accessKeyId | String | Definition AK of a temporary security credential Range N/A |
| secretAccessKey | String | Definition SK of a temporary security credential Range N/A |
| securityToken | String | Definition security_token of a temporary security credential Range N/A |
| expiration | String | Definition Expiration time of a temporary security credential Range N/A |
Example Requests
Obtain the agency credential for a pod identity association.
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/assume-agency-for-pod-identity
{
"token" : "hQpjbi1XXXXXX...XXXXXKbhBbA0TQ=="
} Example Responses
Status code: 200
The agency credential for the pod identity association has been obtained.
{
"assumedAgency" : {
"urn" : "sts::27680d67da6b47eb82d00a1a1xxxxxx5::assumed-agency:example-agency/cce-{cluster_id}-{pod_id}-{random_UUID}",
"id" : "011e7f329d2241e981a3d63bexxxxxx5:cce-{cluster_id}-{pod_id}-{random_UUID}"
},
"audience" : "service.cce.pods",
"credentials" : {
"accessKeyId" : "HSTANO...XBS55JLJ3",
"secretAccessKey" : "EoWCQrr...SCcw4Whkt2aXKWAr",
"securityToken" : "hQpjbi1XXXXXX...XXXXXKbhBbA0TQ==",
"expiration" : "2022-09-07T03:27:51.158Z"
},
"podIdentityAssociationId" : "402358e8-2e3a-4531-bae7-fe9cbxxxxxx1",
"subject" : {
"namespace" : "example-namespace",
"serviceAccount" : "example-serviceaccount"
}
} SDK Sample Code
The SDK sample code is as follows.
Obtain the agency credential for a pod identity association.
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 51 | 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.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class AssumeAgencyForPodIdentitySolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); AssumeAgencyForPodIdentityRequest request = new AssumeAgencyForPodIdentityRequest(); request.withClusterId("{cluster_id}"); AssumeAgencyForPodIdentityRequestBody body = new AssumeAgencyForPodIdentityRequestBody(); body.withToken("hQpjbi1XXXXXX...XXXXXKbhBbA0TQ=="); request.withBody(body); try { AssumeAgencyForPodIdentityResponse response = client.assumeAgencyForPodIdentity(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()); } } } |
Obtain the agency credential for a pod identity association.
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 huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = AssumeAgencyForPodIdentityRequest() request.cluster_id = "{cluster_id}" request.body = AssumeAgencyForPodIdentityRequestBody( token="hQpjbi1XXXXXX...XXXXXKbhBbA0TQ==" ) response = client.assume_agency_for_pod_identity(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Obtain the agency credential for a pod identity association.
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 51 52 53 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.AssumeAgencyForPodIdentityRequest{} request.ClusterId = "{cluster_id}" request.Body = &model.AssumeAgencyForPodIdentityRequestBody{ Token: "hQpjbi1XXXXXX...XXXXXKbhBbA0TQ==", } response, err := client.AssumeAgencyForPodIdentity(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 | The agency credential for the pod identity association has been obtained. |
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