Event Notifications CLI 참조
명령줄 인터페이스(CLI)를 사용하여 Event Notifications 를 활용하려면, IBM Cloud 플러그인 저장소에서 ‘ Event Notifications ’ CLI 플러그인을 설치하면 됩니다. 이 플러그인은 IBM Cloud CLI가 제공하는 기능을 확장하기 위해 설계되었습니다.
전제조건
- IBM Cloud 계정.
- 다음의 인스턴스 Event Notifications 의 인스턴스.
- 로컬 시스템에 설치된 IBM Cloud CLI. IBM Cloud CLI 사용에 대한 도움이 필요하시면 참조 카드를 확인해 주세요.
IBM Cloud CLI 에 로그인하면 업데이트가 있을 때 알림이 표시됩니다. Event Notifications CLI 플러그인에서 사용할 수 있는 새로운 명령어와 플래그를 모두 활용할 수 있도록 CLI를 항상 최신 상태로 유지하시기 바랍니다.
Event Notifications CLI 설치
plugin install 명령어를 사용하여 Event Notifications CLI 플러그인을 설치하십시오.
ibmcloud plugin install event-notifications
1.15.2 이전 버전의 플러그인은 더 이상 사용되지 않습니다.
Event Notifications CLI 명령어
init 명령어는 더 이상 권장되지 않으며, 향후 릴리스에서 제거될 예정입니다.
ibmcloud event-notifications en-list
설정된 대상 지역의 인스턴스를 나열합니다. 나열된 인스턴스에서 인스턴스 GUID를 검색할 수 있습니다.
ibmcloud event-notifications en-list
예
ibmcloud event-notifications en-list
대상 영역 설정
ibmcloud target 명령을 사용하여 작업할 영역을 설정하십시오.
ibmcloud target -r REGION
또는 다음 예시와 같이 IBMCLOUD_EN_ENDPOINT 변수를 통해 지역 엔드포인트를 내보낼 수도 있습니다.
export IBMCLOUD_EN_ENDPOINT= https://au-syd.event-notifications.cloud.ibm.com/event-notifications
지역 엔드포인트를 ‘공개’ 또는 ‘비공개’로 설정하려면 다음 옵션을 참조하십시오
-
사용 가능한 공개 엔드포인트:
- 댈러스:
https://us-south.event-notifications.cloud.ibm.com/event-notifications - 런던:
https://eu-gb.event-notifications.cloud.ibm.com/event-notifications - 시드니:
https://au-syd.event-notifications.cloud.ibm.com/event-notifications - 프랑크푸르트:
https://eu-de.event-notifications.cloud.ibm.com/event-notifications - 마드리드:
https://eu-es.event-notifications.cloud.ibm.com/event-notifications - 오사카:
https://jp-osa.event-notifications.cloud.ibm.com/event-notifications - 도쿄:
https://jp-tok.event-notifications.cloud.ibm.com/event-notifications - 토론토:
https://ca-tor.event-notifications.cloud.ibm.com/event-notifications - 상파울루:
https://br-sao.event-notifications.cloud.ibm.com/event-notifications - 몬트리올:
https://ca-mon.event-notifications.cloud.ibm.com/event-notifications - 워싱턴 D.C.:
https://us-east.event-notifications.cloud.ibm.com/event-notifications - 첸나이:
https://in-che.event-notifications.cloud.ibm.com/event-notifications - 뭄바이:
https://in-mum.event-notifications.cloud.ibm.com/event-notifications
- 댈러스:
-
사용 가능한 비공개 엔드포인트:
- 댈러스:
https://private.us-south.event-notifications.cloud.ibm.com/event-notifications - 런던:
https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications - 시드니:
https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications - 프랑크푸르트:
https://private.eu-de.event-notifications.cloud.ibm.com/event-notifications - 마드리드:
https://private.eu-es.event-notifications.cloud.ibm.com/event-notifications - 오사카:
https://private.jp-osa.event-notifications.cloud.ibm.com/event-notifications - 도쿄:
https://private.jp-tok.event-notifications.cloud.ibm.com/event-notifications - 토론토:
https://private.ca-tor.event-notifications.cloud.ibm.com/event-notifications - 상파울루:
https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications - 몬트리올:
https://private.ca-mon.event-notifications.cloud.ibm.com/event-notifications - 워싱턴 D.C.:
https://private.us-east.event-notifications.cloud.ibm.com/event-notifications - 첸나이:
https://private.in-che.event-notifications.cloud.ibm.com/event-notifications - 뭄바이:
https://private.in-mum.event-notifications.cloud.ibm.com/event-notifications
- 댈러스:
또한 EVENT_NOTIFICATIONS_API_KEY 변수를 내보내어 Event Notifications 인스턴스에 대한 API 키 또는 서비스 자격 증명 API 키를 구성할 수도 있습니다.
소스
IBM Cloud Event Notifications 소스에서 작동합니다.
ibmcloud event-notifications source-create
Event Notifications 가 소비할 수 있는 이벤트를 생성하도록 서비스를 구성하는 소스를 생성합니다. 소스를 구성하려는 Event Notifications 인스턴스의 ID를 반드시 입력해야 합니다. 소스 유형 및 Event Notifications 에 소스를 등록하는 방법에 대한 자세한 내용은 ‘ Event Notifications 소스 추가’를 참조하십시오.
현재 CLI는 API 소스 생성 기능만 지원합니다.
ibmcloud event-notifications source-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] --enabled ENABLED [--store-notifications STORE-NOTIFICATIONS]
source-create 와 sources-create 모두 지원됩니다. 다른 명령어와의 일관성을 위해 source-create 을 사용하십시오.
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name NAME(문자열)-
API 소스에 지정할 이름입니다. 필수.
기본값은
입니다. 최대 길이는255자입니다. 최소 길이는1자입니다. 값은 정규 표현식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/과 일치해야 합니다. --description(문자열)-
API 소스에 대한 설명.
기본값은 ``입니다. 최대 길이는
255자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --enabled(부울)-
소스를 활성화하거나 비활성화합니다. 필수. 소스를 활성화하려면 ‘
true’로 설정하십시오. --store-notifications(부울)-
알림 저장. 문제 해결을 위해 수신 이벤트의 페이로드를 확인할 수 있도록 알림을 저장하려면
true로 설정하십시오.
예
ibmcloud event-notifications source-create \
--instance-id=exampleString \
--name=exampleString \
--description=exampleString \
--enabled=true \
--store-notifications=false
ibmcloud event-notifications source-update
소스 ID를 사용하여 소스 매개변수를 업데이트합니다. 또한 소스가 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
소스의 고유 식별자입니다. 필수.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --name(문자열)-
API 소스의 업데이트된 이름입니다.
기본값은
입니다. 최대 길이는255자입니다. 최소 길이는1자입니다. 값은 정규 표현식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/과 일치해야 합니다. --description(문자열)-
API 소스에 대한 업데이트된 설명입니다.
기본값은 ``입니다. 최대 길이는
255자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --enabled(부울)-
소스를 활성화하거나 비활성화합니다.
값이 true이면 소스를 활성화하고, false이면 소스를 비활성화합니다.
--store-notifications(부울)-
알림 저장. 문제 해결을 위해 수신되는 이벤트의 페이로드를 확인할 수 있습니다.
기본값은
false입니다.
예
ibmcloud event-notifications source-update \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString \
--enabled=true \
--store-notifications=false
ibmcloud event-notifications sources
지정된 인스턴스에 포함된 모든 소스를 나열합니다.
ibmcloud event-notifications sources --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
최대값은
100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
최소값은
0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
소스 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications sources \
--instance-id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications source
특정 소스의 세부 정보를 확인합니다.
ibmcloud event-notifications source --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
소스의 고유 식별자입니다. 필수.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications source \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications source-delete
소스를 삭제합니다.
ibmcloud event-notifications source-delete --instance-id INSTANCE-ID --id ID
명령 옵션
--id(문자열)-
소스의 고유 ID입니다. 필수.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --force-
확인 메시지를 건너뛰고 리소스를 강제로 삭제합니다.
예
ibmcloud event-notifications source-delete \
--instance-id=exampleString \
--id=exampleString
목적지
IBM Cloud Event Notifications 목적지에서 작동합니다.
ibmcloud event-notifications destination-create
알림의 전달 대상으로 사용할 수 있는 수신처를 생성합니다. 목적지는 알림을 사람 사용자에게 전달하도록 설정하거나 자동화된 서비스에 전달하도록 설정할 수 있습니다.
ibmcloud event-notifications destination-create --instance-id INSTANCE-ID --name NAME --type TYPE [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name(문자열)-
대상의 이름입니다. 필수.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --type(문자열)-
대상 유형. 사용자용 대상:
smtp_ibm,sms_ibm,smtp_custom,sms_custom,event_streams,msteams,pagerduty,push_android,push_chrome,push_firefox,push_huawei,push_ios,push_safari,servicenow,slack. 서비스용 대상:ibmce,ibmcos,webhook. 필수.최소 길이는
1자입니다. --description(문자열)-
대상에 대한 설명입니다.
기본값은
입니다. 최대 길이는255자입니다. 최소 길이는0자입니다. 값은 정규 표현식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/과 일치해야 합니다. --collect-failed-events(부울)-
Cloud Object Storage 버킷에 실패한 이벤트를 수집하려면
true로 설정하세요. 실패한 이벤트를 수집하려면 이 인스턴스에 대해 ‘ Cloud Object Storage ’ 통합을 활성화하십시오. 기본값은false입니다. --config(DestinationConfig예)-
대상에 대한 구성입니다.
--config를 지정하지 않고 대상 위치를 생성하면, 대상 위치는 생성되지만 구성을 완료할 때까지는 작동하지 않습니다. --certificate(문자열)-
APNs 또는 iOS 푸시 수신처에 대한 인증서 파일 경로입니다. p8 및 p12 인증서 파일을 지원합니다.
--certificate-content-type(문자열)-
iOS 대상에 대한 인증서의 콘텐츠 유형. 허용되는 값은
p8및p12입니다. --icon16x16(문자열)-
Safari 아이콘의 파일 경로 16x16 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon16x16-content-type(문자열)-
Safari 아이콘 16x16 의 콘텐츠 유형.
--icon16x162x(문자열)-
Safari 아이콘의 파일 경로는 16x16@2x 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon16x162x-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 16x16@2x 입니다.
--icon32x32(문자열)-
Safari 아이콘의 파일 경로 32x32 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon32x32-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 32x32.
--icon32x322x(문자열)-
Safari 아이콘의 파일 경로는 32x32@2x 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon32x322x-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 32x32@2x 입니다.
--icon128x128(문자열)-
Safari 아이콘의 파일 경로: 128x128.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon128x128-content-type(문자열)-
Safari 아이콘 128x128 의 콘텐츠 유형입니다.
--icon128x1282x(문자열)-
Safari 아이콘의 파일 경로 128x128@2x.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon128x1282x-content-type(문자열)-
Safari 아이콘 128x128@2x 의 콘텐츠 유형.
Cloud Functions 더 이상 목적지로 지원되지 않습니다.
예제
ibmcloud event-notifications destination-create \
--instance-id=exampleString \
--name=exampleString \
--type=webhook \
--description=exampleString \
--collect-failed-events=false \
--config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
--certificate=tempdir/test-file.txt \
--certificate-content-type=exampleString \
--icon16x16=tempdir/test-file.txt \
--icon16x16-content-type=exampleString \
--icon16x162x=tempdir/test-file.txt \
--icon16x162x-content-type=exampleString \
--icon32x32=tempdir/test-file.txt \
--icon32x32-content-type=exampleString \
--icon32x322x=tempdir/test-file.txt \
--icon32x322x-content-type=exampleString \
--icon128x128=tempdir/test-file.txt \
--icon128x128-content-type=exampleString \
--icon128x1282x=tempdir/test-file.txt \
--icon128x1282x-content-type=exampleString
-
다음 예제는 P8 인증서를 사용하는 iOS 대상(push_ios)에 대한
DestinationConfig객체의 형식을 보여줍니다.pre_prod를 true로 설정하여 대상을 사전 제작 대상으로 구성하거나, 그렇지 않으면 false로 설정하십시오{ "params" : { "cert_type" : "p8", "is_sandbox" : true, "key_id": "production", "team_id": "1234", "bundle_id": "test1", "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예제는 P12 인증서를 사용하는 iOS 대상(push_ios)에 대한
DestinationConfig객체의 형식을 보여줍니다.pre_prod를 true로 설정하여 대상을 사전 제작 대상으로 구성하거나, false로 설정하십시오.{ "params" : { "cert_type" : "p12", "is_sandbox" : true, "password": "apnspasswordvalue", "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예제는 Chrome 대상(push_chrome)에 대한
DestinationConfig객체의 형식을 보여줍니다.pre_prod를 true로 설정하여 대상을 사전 제작 대상으로 구성하거나, false로 설정하십시오.{ "params" : { "api_key": "chromeapikey", "website_url" : "https://testwebsite.com", "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예제는 Firefox 대상(push_firefox)에 대한
DestinationConfig객체의 형식을 보여줍니다.pre_prod를 true로 설정하여 대상을 사전 제작 대상으로 구성하거나, false로 설정하십시오.{ "params" : { "website_url" : "https://testwebsite.com", "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예는 유형이 incoming_webhook인 슬랙 대상(slack)에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "type" : "incoming_webhook", "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk" } } -
다음 예는 Slack 대상(slack)에 대한 direct_message 유형의
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "type" : "direct_message", "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec" } } -
다음 예제는 Safari 목적지(push_safari)에 대한
DestinationConfig객체의 형식을 보여줍니다.pre_prod를 true로 설정하여 대상을 사전 제작 대상으로 구성하거나, false로 설정하십시오.{ "params": { "cert_type":"p12", "certificate_name":"Users/Testuser/Documents/safari.p12", "password":"safarinew", "url_format_string":"https://test.com", "website_name":"testwebsite", "website_push_id":"test", "website_url":"https://test.com", "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예제는 MS Teams(msteams) 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "url" : "https://xyz.webhook.office.com" } } -
다음 예제는 PagerDuty(pagerduty ) 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.목적지를 생성하는 동안에는 라우팅 키만 사용하는 것이 좋습니다. API 키는 더 이상 사용되지 않으며 앞으로는 사용할 수 없습니다.
{ "params" : { "routing_key" : "routingkeytoconnecttoPD", "api_key" : "cffunctionnamespaceserviceidapikey" } } -
다음 예제는 Webhook(webhook)에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "url" : "exampleString", "verb" : "get", "custom_headers" : { }, "sensitive_headers" : [ "exampleString" ] } } -
다음 예제는 Android(push_android) 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "project_id" : "6232305230320", "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f", "client_email" : "testuser.123@gmail.com", "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예제는
ServiceNow(servicenow )대상에 대한DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96", "client_secret": "testsecrets", "username": "testuser", "password": "user_password", "instance_name": "testinstancenje" } } -
다음 예제는 ‘ Code Engine (ibmce)’ 대상에 대한 ‘
DestinationConfig’ 객체의 형식을 보여줍니다.코드 엔진 목적지 유형: 애플리케이션
{ "params" : { "type" : "application", "url" : "https://codeengine.test.com", "verb" : "get", "custom_headers" : { }, "sensitive_headers" : [ "exampleString" ] } }코드 엔진 목적지 유형: 작업
{ "params" : { "type" : "job", "job_name" : "custom-job", "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::" } } -
다음 예제는 ‘ IBM Cloud Object Storage (ibmcos)’ 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "bucket_name" : "cos-destination-en-bucket", "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773", "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud" } } -
다음 예시는 Huawei(push_huawei) 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "client_id" : "359705ceddd100eyfew", "client_secret": "testsecrets", "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan) } } -
다음 예시는 사용자 지정 이메일(smtp_custom) 수신처에 대한
DestinationConfig객체의 형식을 보여줍니다. 사용자 지정 이메일 샌드박스(smtp_custom_sandbox) 대상의 경우, 대상 구성 매개변수는 필요하지 않습니다.사용자 지정 도메인 설정 및 확인 절차: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify
{ "params" : { "domain": "mailx.com" } } -
다음 예제는 ‘ Event Streams (event_streams)’ 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::", "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com", "topic": "demo_topic" } } -
다음 예제는 ‘ App Configuration ’(app_configuration) 대상에 대한
DestinationConfig객체의 형식을 보여줍니다.{ "params" : { "type": "features", "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::", "environment_id": "stage", "feature_id": "test" } }DestinationConfig없이도 사용자 지정 SMS 수신처를 생성할 수 있지만, 필요한 개인별 번호를 명시적으로 요청하고 구성하기 전까지는 작동하지 않습니다. 맞춤형 번호를 요청하려면 ‘맞춤형 SMS 번호’를 참조하십시오.
ibmcloud event-notifications destinations
Event Notifications 인스턴스의 모든 대상 목록을 표시합니다.
ibmcloud event-notifications destinations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
최대값은
100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
최소값은
0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
대상 컬렉션의 모든 페이지를 표시하려면 여러 개의 요청을 실행하십시오.
예
ibmcloud event-notifications destinations \
--instance-id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications destination
목적지의 ID를 사용하여 해당 목적지에 대한 세부 정보를 확인하세요.
ibmcloud event-notifications destination --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications destination \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications destination-update
대상 ID를 사용하여 대상 매개변수를 업데이트합니다.
ibmcloud event-notifications destination-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name(문자열)-
목적지의 업데이트된 이름.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --description(문자열)-
목적지에 대한 업데이트된 설명.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --collect-failed-events(부울)-
Cloud Object Storage 버킷에 실패한 이벤트를 수집하려면
true로 설정하세요. 기본값은false입니다. --config(DestinationConfig)-
대상에 대한 업데이트된 구성입니다.
JSON 문자열 옵션을 제공하거나, 파일 경로 옵션을 제공하여 읽을 JSON 파일을 지정합니다. 파일 경로 옵션은
@로 시작해야 합니다(예:--config=@path/to/file.json). --certificate(문자열)-
APNs 또는 iOS 푸시 수신처에 대한 인증서 파일 경로입니다. p8 및 p12 인증서 파일을 지원합니다.
최대 길이는
5000자입니다. 최소 길이는1자입니다. --certificate-content-type(문자열)-
iOS 대상에 대한 인증서의 콘텐츠 유형. 허용되는 값은
p8및p12입니다. --icon16x16(문자열)-
Safari 아이콘의 파일 경로 16x16 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon16x16-content-type(문자열)-
Safari 아이콘 16x16 의 콘텐츠 유형.
--icon16x162x(문자열)-
Safari 아이콘의 파일 경로는 16x16@2x 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon16x162x-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 16x16@2x 입니다.
--icon32x32(문자열)-
Safari 아이콘의 파일 경로 32x32 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon32x32-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 32x32.
--icon32x322x(문자열)-
Safari 아이콘의 파일 경로는 32x32@2x 입니다.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon32x322x-content-type(문자열)-
Safari 아이콘의 콘텐츠 유형 32x32@2x 입니다.
--icon128x128(문자열)-
Safari 아이콘의 파일 경로: 128x128.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon128x128-content-type(문자열)-
Safari 아이콘 128x128 의 콘텐츠 유형입니다.
--icon128x1282x(문자열)-
Safari 아이콘의 파일 경로 128x128@2x.
push_safari의 여행지를 위해.최대 길이는
5000자입니다. 최소 길이는1자입니다. --icon128x1282x-content-type(문자열)-
Safari 아이콘 128x128@2x 의 콘텐츠 유형.
예
ibmcloud event-notifications destination-update \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString \
--collect-failed-events=false \
--config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
--certificate=tempdir/test-file.txt \
--certificate-content-type=exampleString \
--icon16x16=tempdir/test-file.txt \
--icon16x16-content-type=exampleString \
--icon16x162x=tempdir/test-file.txt \
--icon16x162x-content-type=exampleString \
--icon32x32=tempdir/test-file.txt \
--icon32x32-content-type=exampleString \
--icon32x322x=tempdir/test-file.txt \
--icon32x322x-content-type=exampleString \
--icon128x128=tempdir/test-file.txt \
--icon128x128-content-type=exampleString \
--icon128x1282x=tempdir/test-file.txt \
--icon128x1282x-content-type=exampleString
ibmcloud event-notifications destination-delete
ID를 사용하여 대상 위치를 삭제합니다. 또한 대상이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications destination-delete --instance-id INSTANCE-ID --id ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --force(부울)-
명령이 실행되도록 강제합니다.
예
ibmcloud event-notifications destination-delete \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications enabled-countries
SMS 수신처의 ID를 사용하여 해당 수신처가 지원되는 국가 정보를 확인합니다. 또한 대상이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications enabled-countries --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMS 수신처에 대한 고유 식별자. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications enabled-countries \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications test-destination
ID를 사용하여 대상 구성을 테스트합니다. 또한 대상이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다. 지원되는 대상 목록은 ‘대상 테스트’를 참조하십시오.
ibmcloud event-notifications test-destination --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications test-destination \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications sandbox-destination-update
샌드박스 이메일 수신처를 사용자 지정 도메인을 사용하여 프로덕션 환경으로 업그레이드합니다.
ibmcloud event-notifications sandbox-destination-update --instance-id INSTANCE-ID --id ID --domain DOMAIN
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --domain(문자열)-
이메일 도메인. 필수.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications sandbox-destination-update \
--instance-id=exampleString \
--id=exampleString \
--domain=exampleString
ibmcloud event-notifications verify-destination-update
사용자 지정 도메인의 SPF 및 DKIM 레코드를 확인하세요.
ibmcloud event-notifications verify-destination-update --instance-id INSTANCE-ID --id ID --type TYPE
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
목적지의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --type(문자열)-
사용자 지정 도메인 이메일 수신처에 대한 인증 유형. 허용되는 값은
spf및dkim입니다. 필수.최대 길이는
20자입니다. 최소 길이는1자입니다. 값은 정규식/[a-z]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications verify-destination-update \
--instance-id=exampleString \
--id=exampleString \
--type=exampleString
토픽
IBM Cloud Event Notifications 주제에 대해 작업하십시오.
ibmcloud event-notifications topic-create
소스에서 발생하는 이벤트를 수신하고, 구독된 대상에 알림을 전달하기 위한 토픽을 생성합니다. 주제는 여러 소스에 연결될 수 있습니다. 주제를 생성하려면 Event Notifications 인스턴스의 ID를 입력해야 합니다.
자세한 내용은 ‘토픽 만들기’를 참조하십시오.
ibmcloud event-notifications topic-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--sources SOURCES]
명령 옵션
--instance-id INSTANCE-ID(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name NAME(문자열)-
주제의 이름. 필수.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --description DESCRIPTION(문자열)-
주제에 대한 설명.
기본값은 ``입니다. 최대 길이는
255자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --sources SOURCES(TopicCreateSourcesItem[])-
토픽에 연결할 소스 및 필터 구성. 소스 구성 예제를 참조하십시오.
예
ibmcloud event-notifications topic-create \
--instance-id=exampleString \
--name=exampleString \
--description=exampleString \
--sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'
-
다음 예는 주기 타이머 소스에 대한
TopicCreateSourcesItem[]객체의 형식을 보여줍니다.[ { "id" : "exampleString", "rules" : [ { "enabled" : true, "event_schedule_filter": { "starts_at": "2024-12-23T12:00:00.000Z", "ends_at": "2024-12-23T20:00:00.000Z", "expression": "* * * * *" } } ] } ] -
다음 예제는
TopicCreateSourcesItem[]객체의 형식을 보여줍니다.[ { "id" : "exampleString", "rules" : [ { "enabled" : true, "event_type_filter" : "$.*", "notification_filter" : "exampleString" } ] } ] -
다음 예제는
TopicUpdateSourcesItem[]객체의 형식을 보여줍니다.[ { "id" : "exampleString", "rules" : [ { "enabled" : true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter" : "$.notification.findings[0].severity == \'MODERATE\'", "rule_id" : "exampleString" } ] } ]
ibmcloud event-notifications topics
Event Notifications 인스턴스에 생성된 모든 주제를 나열합니다. 인스턴스의 ID를 입력해야 합니다.
ibmcloud event-notifications topics --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
최대값은
100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
최소값은
0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
주제 모음의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications topics \
--instance-id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications topic
주제의 ID를 사용하여 해당 주제에 대한 세부 정보를 확인하세요. 또한 해당 토픽이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications topic --instance-id INSTANCE-ID --id ID [--include INCLUDE]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
해당 토픽의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --include(문자열)-
하위 주제를 포함하십시오.
기본값은 ``입니다. 최대 길이는
20자입니다. 최소 길이는0자입니다. 값은 정규식/[a-z]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications topic \
--instance-id=exampleString \
--id=exampleString \
--include=exampleString
ibmcloud event-notifications topic-update
주제의 ID를 사용하여 해당 주제의 세부 정보를 업데이트합니다. 또한 해당 토픽이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications topic-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES]
topic-replace 을 topic-update 의 별칭으로 사용할 수 있습니다. topic-replace 명령어는 더 이상 권장되지 않으며, 향후 릴리스에서 제거될 예정입니다.
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
해당 토픽의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --name(문자열)-
주제의 업데이트된 이름.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --description(문자열)-
해당 주제에 대한 업데이트된 설명입니다.
기본값은 ``입니다. 최대 길이는
255자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/(과)와 일치해야 합니다. --sources(TopicUpdateSourcesItem[])-
업데이트된 소스 정보 및 필터입니다. 소스 구성 예제를 참조하십시오.
이 옵션은 새로운 소스만 추가합니다. 해당 주제에 이미 연결된 출처는 교체하거나 업데이트할 수 없습니다. 소스 필터를 수정하려면, 해당 소스를 토픽에서 제거한 다음 새로운 필터 구성으로 다시 추가하십시오.
예
ibmcloud event-notifications topic-update \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString \
--sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'
ibmcloud event-notifications topic-delete
ID를 사용하여 주제를 삭제합니다. 또한 해당 토픽이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications topic-delete --instance-id INSTANCE-ID --id ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
해당 토픽의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --force(부울)-
명령이 실행되도록 강제합니다.
예
ibmcloud event-notifications topic-delete \
--instance-id=exampleString \
--id=exampleString
구독
IBM Cloud Event Notifications 구독으로 운영하십시오.
ibmcloud event-notifications subscription-create
이벤트 전달을 위해 대상과 토픽을 연결하는 구독을 생성합니다. 수신처는 토픽을 구독할 수 있으며, 여러 수신처가 동일한 토픽을 구독할 수도 있습니다. 구독을 생성하려면 ‘ Event Notifications ’ 인스턴스의 ID를 입력해야 합니다.
ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES]
명령 옵션
--name(문자열)-
구독의 이름. 필수.
최대 길이는
50자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --description(문자열)-
구독에 대한 설명.
기본값은 ``입니다. 최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --destination-id(문자열)-
토픽에 연결할 대상 ID입니다. 필수.
최대 길이는
150자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --topic-id(문자열)-
구독의 주제 ID입니다. 필수.
최대 길이는
150자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --attributes(SubscriptionCreateAttributes)-
구독을 생성하는 데 필요한 속성들입니다. 속성 예시를 참조하십시오.
예제
ibmcloud event-notifications subscription-create \
--instance-id=exampleString \
--name=exampleString \
--destination-id=exampleString \
--topic-id=exampleString \
--description=exampleString \
--attributes='{"invited": ["exampleString"]}'
- 다음 예제는 웹훅용
SubscriptionCreateAttributes객체의 형식을 보여줍니다.
{
"signing_enabled" : true,
"template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
}
- 다음 예제는 SMS용
SubscriptionCreateAttributes객체의 형식을 보여줍니다.
{
"invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
}
- 다음 예시는 ‘ IBM ’ 이메일용 ‘
SubscriptionCreateAttributes’ 객체의 형식을 보여줍니다.
{
"invited" :["entest@gmail.com"],
"add_notification_payload": true,
"reply_to_mail": "en@ibm.com",
"reply_to_name": "EYS ORG",
"from_name":"ABC ORG"
}
- 다음 예제는 Slack 대상 유형에서 incoming_webhook인 경우의
SubscriptionCreateAttributes객체 형식을 보여줍니다.
{
"attachment_color" : "#FF0000",
"template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
- 다음 예제는 Slack 대상 유형이 direct_message인 경우,
SubscriptionCreateAttributes객체의 형식을 보여줍니다.
{
"channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
"template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
- 다음 예제는 ServiceNow 에 대한
SubscriptionCreateAttributes객체의 형식을 보여줍니다.
{
"assigned_to" : "serviceuser@gmail.com",
"assignment_group" : "incidentgroup"
}
-
다음 예제는 사용자 지정 이메일용
SubscriptionCreateAttributes객체의 형식을 보여줍니다.{ "invited" :["entest@gmail.com"], "add_notification_payload": true, "reply_to_mail": "en@ibm.com", "reply_to_name": "EYS ORG", } -
다음 예는 사용자 지정 이메일 샌드박스에 대한
SubscriptionCreateAttributes개체의 형식을 보여줍니다.{ "invited" :["entest@gmail.com"], "add_notification_payload": true, "reply_to_mail": "en@ibm.com", "reply_to_name": "EYS ORG", "from_name":"ABC ORG", "from_email":"Testuser@mailx.com", "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13", "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa" } -
다음 예제는 Pagerduty/ Event Streams 의
SubscriptionCreateAttributes객체 형식을 보여줍니다.{ "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13", } -
다음 예제는 App Configuration 에 대한
SubscriptionCreateAttributes객체의 형식을 보여줍니다. 대상에 대한 구독을 만들거나 업데이트할 때 App Configuration 대상에 대한 구독을 만들거나 업데이트할 때attributes개체에는 특정 규칙이 있습니다:- 다음 중 하나를 포함해야 합니다.
feature_flag_enabled**또는 **template_id_notification - 두 속성을 함께 포함할 수는 없습니다
이를 통해 기능 플래그 평가나 알림 템플릿 생성 중 올바른 사용 사례에 맞춰 구독이 생성되도록 보장하며, 두 가지가 동시에 적용되는 일은 없습니다.
{ "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34", }{ "feature_flag_enabled": false, } - 다음 중 하나를 포함해야 합니다.
ibmcloud event-notifications subscriptions
Event Notifications 인스턴스에 대해 구성된 모든 구독을 나열합니다. 인스턴스의 ID를 입력해야 합니다.
ibmcloud event-notifications subscriptions --instance-id INSTANCE-ID [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
최소값은
0입니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
최대값은
100입니다. 최소값은1입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
구독 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications subscriptions \
--instance-id=exampleString \
--offset=0 \
--limit=10 \
--search=exampleString
ibmcloud event-notifications subscription
구독 ID를 사용하여 구독에 대한 세부 정보를 확인하세요. 구독이 구성된 Event Notifications 인스턴스의 ID를 반드시 제공해야 합니다.
ibmcloud event-notifications subscription --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
구독에 대한 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications subscription \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications subscription-delete
ID를 사용하여 구독을 삭제합니다. 구독이 구성된 Event Notifications 인스턴스의 ID를 반드시 제공해야 합니다.
ibmcloud event-notifications subscription-delete --instance-id INSTANCE-ID --id ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
구독에 대한 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --force(부울)-
명령이 실행되도록 강제합니다.
예
ibmcloud event-notifications subscription-delete \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications subscription-update
구독 ID를 사용하여 구독의 매개변수를 업데이트합니다. 구독이 구성된 Event Notifications 인스턴스의 ID를 반드시 제공해야 합니다.
ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
구독에 대한 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --name(문자열)-
구독의 업데이트된 이름.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --description(문자열)-
구독에 대한 업데이트된 설명입니다.
기본값은 ``입니다. 최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --attributes(SubscriptionUpdateAttributes)-
업데이트된 속성들. 속성 예시를 참조하십시오.
예제
ibmcloud event-notifications subscription-update \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString \
--attributes='{"invited": {"add": ["exampleString"], "remove": ["exampleString"]}, "subscribed": {"remove": ["exampleString"]}, "unsubscribed": {"remove": ["exampleString"]}}'
-
다음 예제는 웹훅용
SubscriptionUpdateAttributes객체의 형식을 보여줍니다.{ "signing_enabled": true } -
다음 예제는 ‘ IBM ’ SMS용 ‘
SubscriptionUpdateAttributes’ 객체의 형식을 보여줍니다.{ "invited": { "add": ["+8xxxxxxxxxx"], "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"] }, "subscribed": { "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"] }, "unsubscribed": { "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"] } } -
다음 예시는 ‘ IBM ’ 이메일용 ‘
SubscriptionUpdateAttributes’ 객체의 형식을 보여줍니다.{ "invited": { "add": ["example1@gmail.com"], "remove": [] }, "subscribed": { "remove": ["example2@gmail.com"] }, "unsubscribed": { "remove": ["example3@gmail.com"] }, "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "from_name": "IBM", "add_notification_payload": true } -
다음 예제는 사용자 지정 이메일용
SubscriptionUpdateAttributes객체의 형식을 보여줍니다.{ "invited": { "add": ["example1@gmail.com"], "remove": [] }, "subscribed": { "remove": ["example2@gmail.com"] }, "unsubscribed": { "remove": ["example3@gmail.com"] }, "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "from_name": "IBM", "from_email": "test@email.com", "add_notification_payload": true, "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13", "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa" } -
다음 예는 사용자 지정 이메일 샌드박스에 대한
SubscriptionUpdateAttributes개체의 형식을 보여줍니다.{ "invited": { "add": ["example1@gmail.com"], "remove": [] }, "subscribed": { "remove": ["example2@gmail.com"] }, "unsubscribed": { "remove": ["example3@gmail.com"] }, "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "add_notification_payload": true, "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13", "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa" } -
다음 예는 슬랙(Slack)의
SubscriptionUpdateAttributes객체 형식을incoming_webhook로 보여줍니다.{ "attachment_color" : "#FF0000", "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13", } -
다음 예는 슬랙(Slack)의
SubscriptionUpdateAttributes객체 형식을direct_message로 보여줍니다.{ "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}], "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13", } -
다음 예제는 ServiceNow용
SubscriptionUpdateAttributes객체의 형식을 보여줍니다.{ "assigned_to" : "serviceuser@gmail.com", "assignment_group" : "incidentgroup" }- 다음 예제는 Pagerduty/ Event Streams 의
SubscriptionUpdateAttributes객체 형식을 보여줍니다.
{ "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13", }-
다음 예제는 App Configuration 에 대한
SubscriptionCreateAttributes객체의 형식을 보여줍니다. 대상에 대한 구독을 만들거나 업데이트할 때 App Configuration 대상에 대한 구독을 만들거나 업데이트할 때attributes개체에는 특정 규칙이 있습니다:- 다음 중 하나를 포함해야 합니다.
feature_flag_enabled**또는 **template_id_notification - 두 속성을 함께 포함할 수는 없습니다
이를 통해 기능 플래그 평가나 알림 템플릿 생성 중 올바른 사용 사례에 맞춰 구독이 생성되도록 보장하며, 두 가지가 동시에 적용되는 일은 없습니다.
- 다음 중 하나를 포함해야 합니다.
{ "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34", }{ "feature_flag_enabled": false, } - 다음 예제는 Pagerduty/ Event Streams 의
통합
IBM Cloud Event Notifications 통합을 운영합니다.
ibmcloud event-notifications integration-create
Event Notifications 과 IBM Cloud Object Storage 을 연결하는 통합을 생성하세요.
ibmcloud event-notifications integration-create --instance-id INSTANCE-ID --type TYPE --metadata METADATA
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --type(문자열)-
통합의 유형. 지원되는 유형은
collect_failed_events입니다. 필수.최대 길이는
50자입니다. 최소 길이는1자입니다. 허용되는 값은 수집_실패한_이벤트입니다. --metadata(문자열)-
통합을 생성하는 데 필요한 통합 메타데이터. 서식 지정에 대한 도움말은 예시를 참고하세요. 필수.
예제
ibmcloud event-notifications integration-create \
--instance-id=exampleString \
--type=collect_failed_events \
--metadata='{"endpoint": "exampleString", "crn": "exampleString", "bucket_name": "exampleString"}'
다음 예제는 IntegrationCreateAttributes 객체의 형식을 보여줍니다.
{
"endpoint": "https://s3.us-west.cloud-object-storage.appdomain.cloud",
"crn": "crn:v1:bluemix:public:cloud-object-storage:global:xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx::",
"bucket_name": "cloud-object-storage"
}
ibmcloud event-notifications integration-update
ID를 사용하여 기존 연동 설정을 업데이트합니다. 또한 통합이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications integration-update --instance-id INSTANCE-ID --id ID --type TYPE --metadata METADATA
이때 integration-replace 를 통해 연동 설정을 업데이트할 수도 있습니다. 하지만, integration-replace 명령어는 더 이상 권장되지 않으며 향후 릴리스에서 제거될 예정입니다.
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --type(문자열)-
통합 유형입니다. 허용되는 값은
kms,hs-crypto및collect_failed_events입니다. 필수.최대 길이는
50자입니다. 최소 길이는1자입니다. --metadata(문자열)-
통합을 업데이트하는 데 필요한 통합 메타데이터입니다. 서식 지정에 대한 도움말은 예시를 참고하세요. 필수.
--id(문자열)-
통합에 대한 고유 식별자입니다. 필수.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다.
예제
ibmcloud event-notifications integration-update \
--instance-id=exampleString \
--id=exampleString \
--type=exampleString \
--metadata='{"endpoint": "exampleString", "crn": "exampleString", "root_key_id": "exampleString", "bucket_name": "exampleString"}'
다음 예제는 Key Protect 에 대한 IntegrationReplaceAttributes 객체의 형식을 보여줍니다.
{
"endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
"crn" : "crn of key protect",
"root_key_id" : "root key id"
}
ibmcloud event-notifications integrations
Event Notifications 인스턴스에 대해 생성된 연동 항목을 나열합니다.
ibmcloud event-notifications integrations --instance-id INSTANCE-ID [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 번호를 매긴 결과에 대한 페이지 한계입니다.
최대값은
100입니다. 최소값은1입니다. --offset(int64)-
페이지 번호를 매긴 결과에 대한 오프셋입니다.
최소값은
0입니다. --search(문자열)-
결과 필터링을 위해 문자열을 검색합니다.
최대 길이는
100자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
통합 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications integrations \
--instance-id=exampleString \
--offset=0 \
--limit=10 \
--search=exampleString
ibmcloud event-notifications integration
통합의 ID를 사용하여 해당 통합에 대한 세부 정보를 확인하세요. 또한 통합이 구성된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications integration --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
통합에 대한 고유 식별자입니다. 필수.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications integration \
--instance-id=exampleString \
--id=exampleString
템플리트
IBM Cloud Event Notifications 템플릿.
ibmcloud event-notifications template-create
초대장 및 알림용 템플릿을 만드세요. 또한 템플릿을 구성할 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications template-create --instance-id INSTANCE-ID --name NAME --type TYPE --params PARAMS [--description DESCRIPTION]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
256자입니다. 최소 길이는10자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name(문자열)-
템플리트 이름입니다. 필수.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --type(문자열)-
템플릿 유형. 지원되는 유형은
smtp_custom.invitation,smtp_custom.notification,webhook.notification,slack.notification,pagerduty.notification및event_streams.notification입니다. 필수.최대 길이는
24자입니다. 최소 길이는22자입니다. 값은 정규식/^(smtp_custom.notification|smtp_custom.invitation)$/(과)와 일치해야 합니다. --params(TemplateConfig)-
알림에 대한 템플릿 매개변수입니다. 필수. 템플릿 매개변수를 참조하십시오.
이 JSON 옵션은 다른 옵션을 가진 개별 필드를 설정함으로써 제공될 수 있습니다. 이 옵션들은 서로 배타적입니다.
JSON 문자열 옵션을 제공하거나, 파일 경로 옵션을 제공하여 읽을 JSON 파일을 지정합니다. 파일 경로 옵션은
@로 시작해야 합니다(예:--params=@path/to/file.json). --description(문자열)-
템플릿 설명.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --params-body(문자열)-
템플릿 본문. 이 옵션은 JSON 옵션 'params'의 하위 필드에 대한 값을 제공합니다. 이 옵션과 상호 배타적입니다.
최대 길이는
20000자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다. --params-subject(문자열)-
템플릿 제목입니다. 이 옵션은 JSON 옵션 'params'의 하위 필드에 대한 값을 제공합니다. 이 옵션과 상호 배타적입니다.
최대 길이는
1000자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다.
예제
- 다음 예제는 이메일용
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은smtp_custom.notification및smtp_custom.invitation입니다.
ibmcloud event-notifications template-create \
--instance-id=exampleString \
--name=exampleString \
--type=exampleString \
--params='{"body": "exampleString", "subject": "exampleString"}' \
--description=exampleString
- 다음 예제는 Slack용
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은slack.notification입니다.
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type slack.notification \
--params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
--description exampleString
- 다음 예제는 웹훅용
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은webhook.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type webhook.notification \
--params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
--description exampleString
- 다음 예제는 Pagerduty용
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은pagerduty.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type pagerduty.notification \
--params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
--description exampleString
- 다음 예제는 Event Streams 에 대한
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은event_streams.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type event_streams.notification \
--params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
--description exampleString
- 다음 예는 Code Engine Job에 대한
TemplateConfig개체의 형식을 보여줍니다. 지원되는 유형은ibmcejob.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type ibmcejob.notification\
--params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
--description exampleString
- 다음 예는 Code Engine Application/Function에 대한
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은ibmceapp.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type ibmceapp.notification\
--params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
--description exampleString
- 다음 예제는 App Configuration 에 대한
TemplateConfig객체의 형식을 보여줍니다. 지원되는 유형은app_configuration.notification
ibmcloud event-notifications template-create \
--instance-id exampleString \
--name exampleString \
--type app_configuration.notification\
--params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \
--description exampleString
ibmcloud event-notifications templates
Event Notifications 인스턴스에 대해 생성된 모든 사용자 정의 템플릿을 나열합니다. 인스턴스의 ID를 입력해야 합니다.
--all-pages 옵션을 설정하지 않으면, 이 명령어는 컬렉션에서 한 페이지만 가져옵니다.
ibmcloud event-notifications templates --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
256자입니다. 최소 길이는10자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
기본값은
10입니다. 최대값은100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
기본값은
0입니다. 최소값은0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
템플릿 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications templates \
--instance-id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications template
템플릿의 ID를 사용하여 해당 템플릿에 대한 세부 정보를 가져옵니다. 또한 템플릿이 구성된 ‘ Event Notifications ’ 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications template --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --id(문자열)-
템플릿의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications template \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications template-update
Event Notifications 인스턴스 아래에 생성된 기존 템플릿의 세부 정보를 업데이트합니다.
ibmcloud event-notifications template-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--params PARAMS]
template-replace 대신 template-update 을 사용할 수 있습니다. 현재 두 명령어 모두 지원되지만, 향후 릴리스에서는 template-replace 가 더 이상 사용되지 않게 될 예정입니다.
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
256자입니다. 최소 길이는10자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
템플릿의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --name(문자열)-
업데이트된 템플릿 이름.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --description(문자열)-
업데이트된 템플릿 설명.
최대 길이는
255자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --params(TemplateConfig)-
업데이트된 템플릿 매개변수. 템플릿 매개변수를 참조하십시오.
이 JSON 옵션은 다른 옵션을 가진 개별 필드를 설정함으로써 제공될 수 있습니다. 이 옵션들은 서로 배타적입니다.
JSON 문자열 옵션을 제공하거나, 파일 경로 옵션을 제공하여 읽을 JSON 파일을 지정합니다. 파일 경로 옵션은
@로 시작해야 합니다(예:--params=@path/to/file.json).
예제
ibmcloud event-notifications template-replace \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString \
--params='{"body": "exampleString", "subject": "exampleString"}'
ibmcloud event-notifications template-delete
ID를 사용하여 템플릿을 삭제합니다. 또한 템플릿이 구성된 ‘ Event Notifications ’ 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications template-delete --instance-id INSTANCE-ID --id ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
256자입니다. 최소 길이는10자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
템플릿의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. -f, --force(부울)-
명령이 실행되도록 강제합니다.
예
ibmcloud event-notifications template-delete \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications pre-defined-templates
Event Notifications 인스턴스에 대해 미리 정의된 템플릿을 나열합니다.
--all-pages 옵션을 설정하지 않으면, 이 명령어는 컬렉션에서 한 페이지만 가져옵니다.
ibmcloud event-notifications pre-defined-templates --instance-id INSTANCE-ID [--source SOURCE] [--type TYPE] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --source(문자열)-
사전 정의된 템플릿의 소스 유형. 필수.
최대 길이는
50자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다. --type(문자열)-
대상 위치에 기반한 사전 정의된 템플릿의 템플릿 유형. 필수.
최대 길이는
50자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
기본값은
10입니다. 최대값은100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
기본값은
0입니다. 최소값은0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
사전 정의된 템플릿 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications pre-defined-templates \
--instance-id=exampleString \
--source=exampleString \
--type=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications pre-defined-template
ID를 사용하여 미리 정의된 템플릿의 세부 정보를 가져옵니다. 또한 미리 정의된 템플릿이 구성된 ‘ Event Notifications ’ 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications pre-defined-template --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)- IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
--id(문자열)- 사전 정의된 템플릿에 대한 고유 식별자입니다. 필수.
예
ibmcloud event-notifications pre-defined-template \
--instance-id=exampleString \
--id=exampleString
SMTP 구성
IBM Cloud Event Notifications SMTP 구성.
ibmcloud event-notifications smtp-configuration-create
메일 전송을 위한 SMTP 설정을 생성합니다. 자세한 내용은 SMTP 설정을 참조하십시오.
ibmcloud event-notifications smtp-configuration-create --instance-id INSTANCE-ID --name NAME --domain DOMAIN [--description DESCRIPTION]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --name(문자열)-
SMTP 구성의 이름입니다. 필수.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --domain(문자열)-
SMTP 설정을 위한 도메인 이름. 필수.
최대 길이는
512자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다. --description(문자열)-
SMTP 구성에 대한 설명.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-configuration-create \
--instance-id=exampleString \
--name=exampleString \
--domain=exampleString \
--description=exampleString
ibmcloud event-notifications smtp-configurations
Event Notifications 인스턴스에 대한 모든 SMTP 설정을 나열합니다.
--all-pages 옵션을 설정하지 않으면, 이 명령어는 컬렉션에서 한 페이지만 가져옵니다.
ibmcloud event-notifications smtp-configurations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 매김 결과에 대한 페이지 한계입니다.
기본값은
10입니다. 최대값은100입니다. 최소값은1입니다. --offset(int64)-
페이지 매김 결과에 대한 오프셋입니다.
기본값은
0입니다. 최소값은0입니다. --search(문자열)-
결과를 필터링하기 위한 검색 문자열입니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
SMTP 구성 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications smtp-configurations \
--instance-id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications smtp-user-create
SMTP 구성을 위해 SMTP 사용자를 생성합니다. SMTP 구성의 ID와 ‘ Event Notifications ’ 인스턴스의 ID를 반드시 입력해야 합니다.
SMTP 인증 정보는 한 번만 표시됩니다. 나중에 다시 불러올 수 없으므로, 이를 복사하여 안전하게 보관하십시오.
ibmcloud event-notifications smtp-user-create --instance-id INSTANCE-ID --id ID [--description DESCRIPTION] [--username-to-clone USERNAME-TO-CLONE]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 식별자입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP 구성에 대한 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --description(문자열)-
SMTP 사용자에 대한 설명.
최대 길이는
250자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --username-to-clone(문자열)-
복제할 SMTP 사용자의 사용자 이름.
최대 길이는
20자입니다. 최소 길이는1자입니다. 값은 정규식/^[a-z0-9]{18}\\d{2}$/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-user-create \
--instance-id=exampleString \
--id=exampleString \
--description=exampleString \
--username-to-clone=exampleString
ibmcloud event-notifications smtp-users
특정 SMTP 구성에 속한 모든 SMTP 사용자를 나열합니다.
--all-pages 옵션이 설정되어 있지 않으면, 이 명령어는 컬렉션에서 단 한 페이지만 가져옵니다.
ibmcloud event-notifications smtp-users --instance-id INSTANCE-ID --id ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --limit(int64)-
페이지 번호를 매긴 결과에 대한 페이지 한계입니다.
기본값은
10입니다. 최대값은100입니다. 최소값은1입니다. --offset(int64)-
페이지 번호를 매긴 결과에 대한 오프셋입니다.
기본값은
0입니다. 최소값은0입니다. --search(문자열)-
결과 필터링을 위해 문자열을 검색합니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --all-pages(부울)-
smtp-users 컬렉션의 모든 페이지를 표시하려면 여러 요청을 실행하십시오.
예
ibmcloud event-notifications smtp-users \
--instance-id=exampleString \
--id=exampleString \
--limit=10 \
--offset=0 \
--search=exampleString
ibmcloud event-notifications smtp-configuration
Event Notifications 인스턴스의 SMTP 구성에 대한 세부 정보를 확인합니다.
ibmcloud event-notifications smtp-configuration --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-configuration \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications smtp-configuration-update
ID를 사용하여 SMTP 구성을 업데이트합니다. 또한 SMTP 구성이 설정된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications smtp-configuration-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --name(문자열)-
SMTP 이름.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다. --description(문자열)-
SMTP 설명.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-configuration-update \
--instance-id=exampleString \
--id=exampleString \
--name=exampleString \
--description=exampleString
ibmcloud event-notifications smtp-configuration-delete
ID를 사용하여 SMTP 구성을 삭제합니다. 또한 SMTP 구성이 설정된 Event Notifications 인스턴스의 ID도 제공해야 합니다.
ibmcloud event-notifications smtp-configuration-delete --instance-id INSTANCE-ID --id ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-configuration-delete \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications smtp-user
사용자 ID와 SMTP 구성 ID를 사용하여 SMTP 사용자의 세부 정보를 확인합니다.
ibmcloud event-notifications smtp-user --instance-id INSTANCE-ID --id ID --user-id USER-ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --user-id(문자열)-
UserID. 필수.
최대 길이는
256자입니다. 최소 길이는5자입니다. 값은 정규식/.*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-user \
--instance-id=exampleString \
--id=exampleString \
--user-id=exampleString
ibmcloud event-notifications smtp-user-update
사용자 ID와 SMTP 구성 ID를 사용하여 SMTP 사용자를 업데이트합니다.
ibmcloud event-notifications smtp-user-update --instance-id INSTANCE-ID --id ID --user-id USER-ID [--description DESCRIPTION]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --user-id(문자열)-
UserID. 필수.
최대 길이는
256자입니다. 최소 길이는5자입니다. 값은 정규식/.*/(과)와 일치해야 합니다. --description(문자열)-
SMTP 사용자 설명.
최대 길이는
250자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-user-update \
--instance-id=exampleString \
--id=exampleString \
--user-id=exampleString \
--description=exampleString
ibmcloud event-notifications smtp-user-delete
사용자 ID와 SMTP 구성 ID를 사용하여 SMTP 사용자를 삭제합니다.
ibmcloud event-notifications smtp-user-delete --instance-id INSTANCE-ID --id ID --user-id USER-ID [--force]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --user-id(문자열)-
UserID. 필수.
최대 길이는
256자입니다. 최소 길이는5자입니다. 값은 정규식/.*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-user-delete \
--instance-id=exampleString \
--id=exampleString \
--user-id=exampleString
ibmcloud event-notifications smtp-allowed-ips
SMTP 구성에 허용된 모든 IP 주소를 가져옵니다.
ibmcloud event-notifications smtp-allowed-ips --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications smtp-allowed-ips \
--instance-id=exampleString \
--id=exampleString
ibmcloud event-notifications smtp-allowed-ips-update
기존 허용 목록에 대한 지원은 더 이상 권장되지 않습니다. 이제 ‘컨텍스트 기반 제한’을 통해 허용 목록 기능이 활성화되었습니다. 자세한 내용은 SMTP 설정을 참조하십시오.
ibmcloud event-notifications verify-smtp-update
SPF, SKIM 및 en_authorization에 대한 SMTP 구성 도메인을 확인하십시오.
ibmcloud event-notifications verify-smtp-update --instance-id INSTANCE-ID --id ID --type TYPE
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --id(문자열)-
SMTP의 고유 식별자입니다. 필수.
최대 길이는
32자입니다. 최소 길이는32자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --type(문자열)-
SMTP 인증 유형. 허용되는 값은
spf,dkim및en_authorization입니다. 필수.최대 길이는
20자입니다. 최소 길이는1자입니다. 값은 정규식/.*/(과)와 일치해야 합니다.
예
ibmcloud event-notifications verify-smtp-update \
--instance-id=exampleString \
--id=exampleString \
--type=exampleString
메트릭
ibmcloud event-notifications metrics
Event Notifications 인스턴스에 대한 메트릭을 가져옵니다.
ibmcloud event-notifications metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --gte(문자열)-
GTE(보다 큼과 같음), UTC 시간으로 시작 타임스탬프. 필수.
최대 길이는
28자입니다. 최소 길이는1자입니다. 값은 정규식/[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/(과)와 일치해야 합니다. --lte(문자열)-
LTE(less than equal), UTC의 종료 타임스탬프. 필수.
최대 길이는
28자입니다. 최소 길이는1자입니다. 값은 정규식/[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/(과)와 일치해야 합니다. --smtp-config-id(문자열)-
SMTP 구성 ID. SMTP 인터페이스 대상에 대한 메트릭을 조회할 때 필수입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --destination-type(문자열)-
지표가 요청되는 대상 유형. 지원되는 값: smtp_custom. 사용자 지정 이메일 수신처에 대한 메트릭을 조회할 때 필수입니다.
허용되는 값은
smtp_custom입니다. --destination-id(문자열)-
대상에 대한 고유 ID입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --subscription-id(문자열)-
구독의 고유 ID입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --source-id(문자열)-
소스의 고유 ID입니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --email-to(문자열)-
수신자 이메일 아이디.
최대 길이는
256자입니다. 최소 길이는0자입니다. 값은 정규식/[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/(과)와 일치해야 합니다. --notification-id(문자열)-
알림 ID.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --subject(문자열)-
이메일 제목.
최대 길이는
256자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다.
예
ibmcloud event-notifications metrics \
--instance-id=exampleString \
--destination-type=smtp_custom \
--gte=exampleString \
--lte=exampleString \
--destination-id=exampleString \
--subscription-id=exampleString \
--source-id=exampleString \
--email-to=exampleString \
--notification-id=exampleString \
--subject=exampleString
ibmcloud event-notifications bounce-metrics
Event Notifications 인스턴스에 대한 반송 지표를 가져옵니다.
ibmcloud event-notifications bounce-metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT] [--limit LIMIT] [--offset OFFSET]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --gte(문자열)-
UTC 기준 ‘보다 크거나 같음(GTE)’ 시작 타임스탬프. 필수.
최대 길이는
28자입니다. 최소 길이는1자입니다. 값은 정규식/[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/(과)와 일치해야 합니다. --lte(문자열)-
UTC 기준, ‘less than equal(LTE)’ 시작 타임스탬프. 필수.
최대 길이는
28자입니다. 최소 길이는1자입니다. 값은 정규식/[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/(과)와 일치해야 합니다. --smtp-config-id(문자열)-
SMTP 구성 ID. SMTP 인터페이스 대상에 대한 메트릭을 조회할 때 필수입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --destination-type(문자열)-
지표가 요청되는 대상 유형. 지원되는 값: smtp_custom. 사용자 지정 이메일 수신처에 대한 메트릭을 조회할 때 필수입니다.
허용되는 값은
smtp_custom입니다. --destination-id(문자열)-
대상에 대한 고유 ID입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --subscription-id(문자열)-
구독의 고유 ID입니다.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --source-id(문자열)-
소스의 고유 ID입니다.
최대 길이는
100자입니다. 최소 길이는1자입니다. 값은 정규식/[a-zA-Z0-9-:_]*/(과)와 일치해야 합니다. --email-to(문자열)-
수신자 이메일 주소.
최대 길이는
256자입니다. 최소 길이는0자입니다. 값은 정규식/[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/(과)와 일치해야 합니다. --notification-id(문자열)-
알림 ID.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --subject(문자열)-
이메일 제목.
최대 길이는
256자입니다. 최소 길이는0자입니다. 값은 정규식/[a-zA-Z0-9]/(과)와 일치해야 합니다. --limit(int64)-
페이지 번호를 매긴 결과에 대한 페이지 한계입니다.
기본값은
10입니다. 최대값은100입니다. 최소값은1입니다. --offset(int64)-
페이지 번호를 매긴 결과에 대한 오프셋입니다.
기본값은
0입니다. 최소값은0입니다.
예
ibmcloud event-notifications bounce-metrics \
--instance-id=exampleString \
--destination-type=smtp_custom \
--gte=exampleString \
--lte=exampleString \
--destination-id=exampleString \
--subscription-id=exampleString \
--source-id=exampleString \
--email-to=exampleString \
--notification-id=exampleString \
--subject=exampleString \
--limit=10 \
--offset=0
알림 상태 보기
ibmcloud event-notifications notifications-status
웹훅 수신처 테스트 알림의 알림 상태를 확인합니다.
ibmcloud event-notifications notifications-status --instance-id INSTANCE-ID --id ID
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다. --id(문자열)-
웹훅 수신처를 테스트할 때 반환되는 알림 ID입니다. 이 ID는 웹훅 수신처로 전송되는 테스트 알림에 한정됩니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/(과)와 일치해야 합니다.
예
ibmcloud event-notifications notifications-status \
--instance-id=exampleString \
--id=exampleString
알림 전송
API 소스를 사용하여 백엔드 애플리케이션에서 이벤트를 전송하세요. ‘ Event Notifications ’은 두 가지 CloudEvents 콘텐츠 모드를 지원합니다:
- 바이너리 모드 — 이벤트 데이터는 HTTP 요청 본문에 있는 그대로 포함되며,
Content-Type헤더의datacontenttype속성을 통해 해당 미디어 유형이 선언됩니다. 그 외의 모든 속성은ce-접두사가 붙은 HTTP 헤더에 매핑됩니다. 필수 속성인 CloudEvents (specversion,id,type,source)가 헤더로 전달되면 요청은 바이너리 모드로 처리됩니다. - 구조화된 모드 — 이벤트 메타데이터와 이벤트 데이터는 HTTP 요청 본문에 포함됩니다.
Content-Type헤더를application/cloudevents+json로 설정하십시오. 필수 속성(specversion,id,type및source)은 요청 본문에 반드시 포함되어야 합니다.datacontenttype필드는 필수 항목이며, 반드시application/json로 설정해야 합니다.
ibmcloud event-notifications send-notifications
서비스 인스턴스에서 알림을 전송합니다. 알림 페이로드에 대한 자세한 내용은 문서를 참조하세요.
ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY]
명령 옵션
--instance-id(문자열)-
IBM Cloud Event Notifications 인스턴스의 고유 ID입니다. 필수.
최대 길이는
36자입니다. 최소 길이는36자입니다. 값은 정규식/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/(과)와 일치해야 합니다. --body(NotificationCreate)-
알림 생성 요청을 설명하는 페이로드.
JSON 문자열 옵션을 제공하거나, 파일 경로 옵션을 제공하여 읽을 JSON 파일을 지정합니다. 파일 경로 옵션은
@로 시작해야 합니다(예:--body=@path/to/file.json).
NotificationCreate
다음 예제는 NotificationCreate 객체의 형식을 보여줍니다.
{
"specversion" : "1.0",
"time" : "2019-01-01T12:00:00.000Z",
"id" : "exampleString",
"source" : "exampleString",
"type" : "exampleString",
"ibmenseverity" : "exampleString",
"ibmensourceid" : "exampleString",
"ibmendefaultshort" : "exampleString",
"ibmendefaultlong" : "exampleString",
"ibmensubject" : "exampleString",
"ibmentemplates" : "[\"886f8f4c-8605-47hb-85a1-8682b9377468483\"]",
"ibmenmailto" : "exampleString",
"ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]",
"ibmensmsto" : "exampleString",
"ibmenmms": {"content": "VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO","content_type": "image/png"},
"ibmenmarkdownn": "This is a *italic* message.\n- Item 1\n- Item 2\n**bold text** with more text data\n~~strike through~~\n1. order 1\n2. order 2\n```fenced code block```\n> block code\n`code`\n[Click here](https://example.com) for more info."
"ibmenhtmlbody" : "exampleString",
"subject" : "exampleString",
"attachments": [
{
"content": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQK",
"filename": "test.txt",
"content_type": "text/plain",
"disposition": "attachment"
}
],
"data" : {
"anyKey" : "anyValue"
},
"datacontenttype" : "application/json",
"ibmenpushto" : "{
\"fcm_devices\" : [ \"exampleString\" ],
\"apns_devices\" : [ \"exampleString\" ],
\"huawei_devices\" : [ \"exampleString\" ],
\"safari_devices\" : [ \"exampleString\" ],
\"chrome_devices\" : [ \"exampleString\" ],
\"firefox_devices\" : [ \"exampleString\" ],
\"user_ids\" : [ \"exampleString\" ],
\"tags\" : [ \"exampleString\" ],
\"platforms\" : [ \"push_android\" ]
}",
"ibmenfcmbody" : "{ }",
"ibmenapnsbody" : "{ }",
"ibmenapnsheaders" : "{ }",
"ibmenchromebody" : "{ }",
"ibmenchromeheaders" : "{ }",
"ibmenfirefoxbody" : "{ }",
"ibmenfirefoxheaders" : "{ }",
"ibmenhuaweibody" : "{ }",
"ibmensafaribody" : "{ }"
}
예
필수 매개변수가 있는 경우:
ibmcloud event-notifications send-notifications \
--instance-id=exampleString \
--body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "type": "*", "id": "exampleString", "source": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "short message", "ibmendefaultlong": "long message", "data": {"name": "exampleString"}, "datacontenttype": "application/json"}'
모든 매개변수를 포함하여:
ibmcloud event-notifications send-notifications \
--instance-id=exampleString \
--body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "id": "exampleString", "source": "exampleString", "type": "exampleString", "ibmenseverity": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "exampleString", "ibmendefaultlong": "exampleString", "ibmensubject": "exampleString", "ibmentemplates": [\"template-id\"], "ibmenmailto": "exampleString","ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]", "ibmensmsto": "exampleString","ibmenmms": "{\"content\": \"VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO\",\"content_type\": \"image/png\"}", "ibmenhtmlbody": "exampleString", "subject": "exampleString", "data": {"anyKey": "anyValue"}, "datacontenttype": "application/json", "ibmenpushto": "{\"fcm_devices\": [\"exampleString\"], \"apns_devices\": [\"exampleString\"], \"huawei_devices\": [\"exampleString\"], \"safari_devices\": [\"exampleString\"], \"chrome_devices\": [\"exampleString\"], \"firefox_devices\": [\"exampleString\"], \"user_ids\": [\"exampleString\"], \"tags\": [\"exampleString\"], \"platforms\": [\"push_android\"]}", "ibmenfcmbody": "{}", "ibmenapnsbody": "{}", "ibmenapnsheaders": "{}", "ibmenchromebody": "{}", "ibmenchromeheaders": "{}", "ibmenfirefoxbody": "{}", "ibmenfirefoxheaders": "{}", "ibmenhuaweibody": "{}", "ibmensafaribody": "{}"}'
IOS 알림을 위해 구성할 수 있는 추가 특성
| 특성 | 특성 유형 | 설명 |
|---|---|---|
badge |
정수 | 애플리케이션 아이콘의 배지로서 표시할 숫자입니다. |
interactive_category |
문자열 | 대화식 푸시 알림에 사용되는 카테고리 ID입니다. |
ios_action_key |
문자열 | 조치 키의 제목입니다. |
payload |
JSON 오브젝트 | 알림 메시지의 일부로서 전송된 사용자 정의 JSON 페이로드입니다. |
sound |
문자열 | 애플리케이션 번들에서 사운드 파일의 이름입니다. 이 파일의 사운드는 경보로서 재생됩니다. |
title_loc_key |
문자열 | 현재 현지화에 맞는 Localizable.strings 파일의 title 문자열에 대한 키입니다. 키 문자열은 titleLocArgs 배열에 지정된 변수를 사용하도록 %@ 및 %n$@ 지정자를 사용하여 형식화될 수 있습니다. |
loc_key |
문자열 | 현재 현지화에 맞는 Localizabl.strings 파일의 경보 메시지 문자열에 대한 키입니다. 키 문자열은 locArgs 배열에 지정된 변수를 사용하도록 %@ 및 %n$@ 지정자를 사용하여 형식화될 수 있습니다. |
launch_image |
문자열 | 앱 번들에 포함된 이미지 파일의 파일 이름으로, 파일 확장자를 포함하거나 포함하지 않은 것을 말합니다. 이 이미지는 사용자가 액션 단추를 탭하거나 액션 슬라이더를 이동할 때 실행 이미지로 사용됩니다. |
title_loc_args |
문자열 | title-loc-key에서 형식 지정자 대신 표시될 변수 문자열 값입니다. |
loc_args |
문자열 | locKey에서 형식 지정자 대신 표시될 변수 문자열 값입니다. |
title |
문자열 | 리치 푸시 알림의 제목입니다(iOS 10 이상에서만 지원됨). |
subtitle |
문자열 | 리치 알림의 하위 제목입니다(iOS 10 이상에서만 지원됨). |
body |
문자열 | iOS 알림의 본문입니다. |
attachment_url |
문자열 | iOS 알림 매체에 대한 링크입니다(동영상, 오디오, GIF, 이미지 - iOS 10 이상에서만 지원됨). |
type |
문자열 | 허용 가능한 값: DEFAULT, MIXED, SILENT. |
apns_collapse_id |
문자열 | 동일한 접기 ID가 사용된 여러 알림은 하나의 알림으로 사용자에게 표시됩니다. |
apns_thread_id |
문자열 | 관련 알림을 그룹화하기 위한 앱 특정 ID입니다. 이 값은 UNNotificationContent 오브젝트의 threadIdentifier 특성에 해당합니다. |
apns_group_summary_arg |
문자열 | 알림이 카테고리의 요약 형식 문자열에 추가하는 문자열입니다. |
apns_group_summary_arg_count |
정수 | 알림이 카테고리의 요약 형식 문자열에 추가하는 항목의 수입니다. |
FCM 알림에 대해 구성할 수 있는 추가 특성
| 특성 | 특성 유형 | 설명 |
|---|---|---|
icon |
문자열 | 알림을 위해 표시되는 아이콘의 이름을 지정합니다. 아이콘이 클라이언트 애플리케이션에 이미 패키징되어 있는지 확인하십시오. |
delay_while_idle |
부울 | true로 설정되면 이 매개변수는 디바이스가 활성화될 때까지 메시지를 보내지 않음을 표시합니다. |
sync |
부울 | 디바이스 그룹 메시징은 그룹의 모든 앱 인스턴스가 최신 메시징 상태를 반영할 수 있도록 허용합니다. |
visibility |
문자열 | 비공개 또는 공개 - 이 알림의 표시 범위로, 보안 잠금 화면에서 알림이 표시되는 방식과 시기에 영향을 미칩니다. |
redact |
문자열 | 가시성이 개인용으로 설정된 경우 지정된 컨텐츠가 디바이스의 보안 잠금 화면에 표시됩니다. |
payload |
JSON 오브젝트 | 알림 메시지의 일부로서 전송된 사용자 정의 JSON 페이로드입니다. |
priority |
문자열 | 이 알림의 우선순위를 표시하는 문자열 값입니다. 허용되는 값은 'max', 'high', 'default', 'low' 및 'min'입니다. 'sound' 필드와 함께 표시되는 높은/낮은 우선 순위 알림은 Android 5.0의 헤드업 알림 또는 higher.sampleval='low'에 사용될 수 있습니다. |
sound |
문자열 | 디바이스에 알림이 수신될 때 재생할 사운드 파일입니다(디바이스에 있음). |
time_to_live |
정수 | 디바이스가 오프라인인 경우 메시지를 GCM 스토리지에 보관해야 하는 시간(초)을 지정합니다. |
lights |
푸시 알림 수신 시 알림 LED 색상을 설정합니다. | |
ledArgb |
문자열 | LED 색상입니다. 하드웨어는 최상의 추정을 수행합니다. |
ledOnMs |
정수 | 깜박이는 동안 LED가 켜지는 시간(밀리초)입니다. 하드웨어는 최상의 추정을 수행합니다. |
ledOffMs |
문자열 | 깜박이는 동안 LED가 오프되는 시간(밀리초)입니다. 하드웨어는 최상의 추정을 수행합니다. |
android_title |
문자열 | 리치 푸시 알림의 제목입니다. |
group_id |
문자열 | 동일한 키를 공유하는 알림 그룹의 일부가 되도록 이 알림을 설정합니다. 그룹화된 알림은 이러한 렌더링을 지원하는 디바이스의 클러스터 또는 스택에 표시될 수 있습니다. |
style |
Android 확장 가능 알림에 대해 지정할 옵션입니다. 확장 가능 알림 유형은 picture_notification, bigtext_notification, inbox_notification입니다. | |
type |
문자열 | 확장 가능한 알림의 유형을 지정합니다. 가능한 값은 bigtext_notification, picture_notification, inbox_notification입니다. |
title |
문자열 | 알림의 제목을 지정합니다. 제목은 알림이 확장될 때 표시됩니다. 3개의 모든 확장 가능 알림에 대해 제목을 지정해야 합니다. |
type |
문자열 | 허용되는 값: DEFAULT, SILENT. |
alert |
문자열 | 알림의 경보 값입니다. |
샘플 스크립트
개발에 도움이 되도록 다음 스크립트를 사용할 수 있습니다.
CLI를 사용한 Event Notifications 프로비저닝을 위한 샘플 스크립트
스크립트는 provision_event_notification.sh 스크립트는 Event Notifications 인스턴스의 프로비저닝 및 구성을 자동화합니다.
CLI를 사용한 플랫폼 알림 통합을 위한 샘플 스크립트
스크립트는 en-platform-notification-src-and-email-dest.sh 스크립트는 플랫폼 알림을 Event Notifications 와 통합하고 알림을 IBM 기본 제공 이메일 또는 사용자 지정 도메인 샌드박스로 라우팅합니다.
CLI를 사용한 IBM Cloud Logs 통합을 위한 샘플 스크립트
스크립트는 en-icl-src-and-email-dest.sh 스크립트는 IBM Cloud Logs 와 Event Notifications 를 통합하고 알림을 IBM 내장 이메일 또는 사용자 지정 도메인 샌드박스로 라우팅합니다.
이 스크립트에서는 IBM Cloud Logs 인스턴스와 Event Notifications 인스턴스가 동일한 계정에 있다고 가정합니다.