使用CreateSecret API建立保密字典-Serverless 應用引擎-阿里雲 - Serverless App Engine

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:CreateSecret

*全部資源

*

無

請求文法

POST /pop/v1/sam/secret/secret HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
NamespaceId	string	是	Secret 執行個體所在命名空間 ID。如果所在命名空間為預設命名空間，則只需填寫 RegionId，例如`cn-beijing`。	cn-beijing:test
SecretName	string	是	Secret 執行個體名稱。允許數字、字母和底線（_）組合，僅允許以字母開頭。	registry-auth-acree
SecretType	string	是	當前支援的 Secret 執行個體類型。取值說明如下： kubernetes.io/dockerconfigjson：儲存鏡像倉庫使用者名稱和密碼的保密字典，用於部署時拉取鏡像鑒權。	kubernetes.io/dockerconfigjson
SecretData	object	是	Secret 資料。
SecretData	string	是	Secret 索引值對資料，為必填項。格式如下： {"Data":"{"k1":"v1", "k2":"v2"}"} k 表示鍵，v 表示值。	{".dockerconfigjson":"eyJhdXRocyI6eyJyZWdpc3RyeS12cGMuY24tYmVpamluZy5hbGl5dW5jcy5jb20iOnsidXNlcm5hbWUiOiJ1c2VybmFtZSIsInBhc3N3b3JkIjoicGFzc3dvcmQiLCJhdXRoIjoiZFhObGNtNWhiV1U2Y0dGemMzZHZjbVE9In0sInJlZ2lzdHJ5LmNuLWJlaWppbmcuYWxpeXVuY3MuY29tIjp7InVzZXJuYW1lIjoidXNlcm5hbWUiLCJwYXNzd29yZCI6InBhc3N3b3JkIiwiYXV0aCI6ImRYTmxjbTVoYldVNmNHRnpjM2R2Y21RPSJ9fX0="}

樣本：使用使用者名稱密碼，跨帳號內網拉取Container Registry ACR 的鏡像

請同時填寫公網與內網網域名稱。
請同時填寫 username、password 與 auth 欄位，避免鑒權失敗。auth 欄位格式base64Encode($username:$password)。

欄位值預設格式如下。

SecretData[".dockerconfigjson"]=base64Encode(
{
  "auths": {
    "registry-vpc.cn-beijing.aliyuncs.com": {  // $內網網域名稱
      "username": "username",
      "password": "password",
      "auth": "dXNlcm5hbWU6cGFzc3dvcmQ="
    },
    "registry.cn-beijing.aliyuncs.com": {     // $公網網域名稱
      "username": "username",                 // $使用者名稱
      "password": "password",                 // $密碼
      "auth": "dXNlcm5hbWU6cGFzc3dvcmQ="      // base64Encode($使用者名稱:$密碼)
    }
  }
} )

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	調用結果的附加資訊。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0a98a02315955564772843261e****
Data	object	返回結果。
SecretId	integer	建立成功的 Secret 執行個體 ID。	16
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	建立 Secret 執行個體是否成功。取值說明如下： true：建立成功。 false：建立失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "SecretId": 16
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的參數：%s不可為空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的參數{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的參數{%s}：%s。
400	SecretNameConflict.AlreadyExist	The specified SecretName [%s] already exist in this namespace.	指定的保密字典名稱已經存在與當前命名空間中。
400	QuotaExceeded.SecretInNamespace	The specified secret exceeded quota [%s].	超過保密字典上限 [%s]。
400	QuotaExceeded.SecretDataKey	The specified key in SecretData exceeded quota [%s].	保密字典欄位數量超過上限 [%s].
400	InvalidSecretType.NotAvailable	The specified SecretType [%s] is not supported.	指定的保密字典類型不支援。
400	InvalidSecretDataKey.NotFound	The specified Key [%s] does not exist in the specified Secret [%s].	指定的保密字典Key不存在於當前保密字典[%s]中
500	OperationFailed.RPCError	Internal RPC request processing error.	內部RPC請求處理報錯。
404	InvalidNamespaceId.NotFound	The specified NamespaceId does not exist.	指定的NamespaceId不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。